home *** CD-ROM | disk | FTP | other *** search
/ Language/OS - Multiplatform Resource Library / LANGUAGE OS.iso / gnu / emacs.lha / emacs-19.16 / lisp / calendar.el < prev    next >
Text File  |  1993-06-21  |  132KB  |  3,023 lines

  1. ;;; calendar.el --- Calendar functions.
  2.  
  3. ;;; Copyright (C) 1988, 1989, 1990, 1991, 1992 Free Software Foundation, Inc.
  4.  
  5. ;; Author: Edward M. Reingold <reingold@cs.uiuc.edu>
  6. ;; Keywords: calendar
  7. ;; Human-Keywords: calendar, Gregorian calendar, Julian calendar, 
  8. ;;    Hebrew calendar, Islamic calendar, ISO calendar, Julian day number,
  9. ;;    diary, holidays
  10.  
  11. (defconst calendar-version "Version 5.1, released June 18, 1993")
  12.  
  13. ;; This file is part of GNU Emacs.
  14.  
  15. ;; GNU Emacs is distributed in the hope that it will be useful,
  16. ;; but WITHOUT ANY WARRANTY.  No author or distributor
  17. ;; accepts responsibility to anyone for the consequences of using it
  18. ;; or for whether it serves any particular purpose or works at all,
  19. ;; unless he says so in writing.  Refer to the GNU Emacs General Public
  20. ;; License for full details.
  21.  
  22. ;; Everyone is granted permission to copy, modify and redistribute
  23. ;; GNU Emacs, but only under the conditions described in the
  24. ;; GNU Emacs General Public License.   A copy of this license is
  25. ;; supposed to have been given to you along with GNU Emacs so you
  26. ;; can know your rights and responsibilities.  It should be in a
  27. ;; file named COPYING.  Among other things, the copyright notice
  28. ;; and this notice must be preserved on all copies.
  29.  
  30. ;;; Commentary:
  31.  
  32. ;; This collection of functions implements a calendar window.  It
  33. ;; generates a calendar for the current month, together with the previous
  34. ;; and coming months, or for any other three-month period.  The calendar
  35. ;; can be scrolled forward and backward in the window to show months in
  36. ;; the past or future; the cursor can move forward and backward by days,
  37. ;; weeks, or months, making it possible, for instance, to jump to the
  38. ;; date a specified number of days, weeks, or months from the date under
  39. ;; the cursor.  The user can display a list of holidays and other notable
  40. ;; days for the period shown; the notable days can be marked on the
  41. ;; calendar, if desired.  The user can also specify that dates having
  42. ;; corresponding diary entries (in a file that the user specifies) be
  43. ;; marked; the diary entries for any date can be viewed in a separate
  44. ;; window.  The diary and the notable days can be viewed independently of
  45. ;; the calendar.  Dates can be translated from the (usual) Gregorian
  46. ;; calendar to the day of the year/days remaining in year, to the ISO
  47. ;; commercial calendar, to the Julian (old style) calendar, to the Hebrew
  48. ;; calendar, to the Islamic calendar, to the French Revolutionary calendar,
  49. ;; to the Mayan calendar, and to the astronomical (Julian) day number.
  50. ;; When floating point is available, times of sunrise/sunset can be displayed,
  51. ;; as can the phases of the moon.  Appointment notification for diary entries
  52. ;; is available.
  53.  
  54. ;; The following files are part of the calendar/diary code:
  55.  
  56. ;;       diary.el, diary-ins.el        Diary functions
  57. ;;       holidays.el                   Holiday functions
  58. ;;       cal-french.el                 French Revolutionary calendar
  59. ;;       cal-mayan.el                  Mayan calendars
  60. ;;       cal-dst.el                    Daylight savings time rules
  61. ;;       solar.el                      Sunrise/sunset, equinoxes/solstices
  62. ;;       lunar.el                      Phases of the moon
  63. ;;       appt.el                       Appointment notification
  64.  
  65. ;; Comments, corrections, and improvements should be sent to
  66. ;;  Edward M. Reingold               Department of Computer Science
  67. ;;  (217) 333-6733                   University of Illinois at Urbana-Champaign
  68. ;;  reingold@cs.uiuc.edu             1304 West Springfield Avenue
  69. ;;                                   Urbana, Illinois 61801
  70.  
  71. ;; GNU Emacs users too numerous to list pointed out a variety of problems
  72. ;; with earlier forms of the `infinite' sliding calendar and suggested some
  73. ;; of the features included in this package.  Especially significant in this
  74. ;; regard was the suggestion of mark-diary-entries and view-diary-entries,
  75. ;; together ideas for their implementation, by
  76. ;;  Michael S. Littman             Cognitive Science Research Group
  77. ;;  (201) 829-5155                   Bell Communications Research
  78. ;;  mlittman@wind.bellcore.com       445 South St. Box 1961 (2L-331)
  79. ;;                                   Morristown, NJ  07960
  80.  
  81. ;; The algorithms for the Hebrew calendar are those of the Rambam (Rabbi Moses
  82. ;; Maimonides), from his Mishneh Torah, as implemented by
  83. ;;  Nachum Dershowitz                Department of Computer Science
  84. ;;  (217) 333-4219                   University of Illinois at Urbana-Champaign
  85. ;;  nachum@cs.uiuc.edu               1304 West Springfield Avenue
  86. ;;                                   Urbana, Illinois 61801
  87.  
  88. ;; Technical details of all the calendrical calculations can be found in
  89.  
  90. ;; ``Calendrical Calculations'' by Nachum Dershowitz and Edward M. Reingold,
  91. ;; Software--Practice and Experience, Volume 20, Number 9 (September, 1990),
  92. ;; pages 899-928.  ``Calendrical Calculations, Part II: Three Historical
  93. ;; Calendars'' by E. M. Reingold,  N. Dershowitz, and S. M. Clamen,
  94. ;; Software--Practice and Experience, Volume 23, Number 4 (April, 1993),
  95. ;; pages 383-404.
  96.  
  97. ;; Hard copies of these two papers can be obtained by sending email to
  98. ;; reingold@cs.uiuc.edu with the SUBJECT "send-paper-cal" (no quotes) and
  99. ;; the message BODY containing your mailing address (snail).
  100.  
  101. ;;; Code:
  102.  
  103. ;;;###autoload
  104. (defvar view-diary-entries-initially nil
  105.   "*If t, the diary entries for the current date will be displayed on entry.
  106. The diary is displayed in another window when the calendar is first displayed,
  107. if the current date is visible.  The number of days of diary entries displayed
  108. is governed by the variable `number-of-diary-entries'.")
  109.  
  110. ;;;###autoload
  111. (defvar number-of-diary-entries 1
  112.   "*Specifies how many days of diary entries are to be displayed initially.
  113. This variable affects the diary display when the command M-x diary is used,
  114. or if the value of the variable `view-diary-entries-initially' is t.  For
  115. example, if the default value 1 is used, then only the current day's diary
  116. entries will be displayed.  If the value 2 is used, then both the current
  117. day's and the next day's entries will be displayed.  The value can also be
  118. a vector such as [0 2 2 2 2 4 1]; this value will cause no diary entries to
  119. be displayed on Sunday, the current date's and the next day's diary entries
  120. to be displayed Monday through Thursday, Friday through Monday's entries to
  121. be displayed on Friday, and only Saturday's entries to be displayed on
  122. Saturday.  This variable does not affect the diary display with the `d'
  123. command from the calendar; in that case, the prefix argument controls the
  124. number of days of diary entries displayed.")
  125.  
  126. ;;;###autoload
  127. (defvar mark-diary-entries-in-calendar nil
  128.   "*If t, dates with diary entries will be marked in the calendar window.
  129. The marking symbol is specified by the variable `diary-entry-marker'.")
  130.  
  131. ;;;###autoload
  132. (defvar diary-entry-marker "+"
  133.   "*The symbol used to mark dates that have diary entries.")
  134.  
  135. ;;;###autoload
  136. (defvar view-calendar-holidays-initially nil
  137.   "*If t, holidays for current three month period will be displayed on entry.
  138. The holidays are displayed in another window when the calendar is first
  139. displayed.")
  140.  
  141. ;;;###autoload
  142. (defvar mark-holidays-in-calendar nil
  143.   "*If t, dates of holidays will be marked in the calendar window.
  144. The marking symbol is specified by the variable `calendar-holiday-marker'.")
  145.  
  146. ;;;###autoload
  147. (defvar calendar-holiday-marker "*"
  148.   "*The symbol used to mark notable dates in the calendar.")
  149.  
  150. ;;;###autoload
  151. (defvar all-hebrew-calendar-holidays nil
  152.   "*If nil, show only major holidays from the Hebrew calendar.
  153.  
  154. If nil, the only holidays from the Hebrew calendar shown will be those days of
  155. such major interest as to appear on secular calendars.
  156.  
  157. If t, the holidays shown in the calendar will include all special days that
  158. would be shown on a complete Hebrew calendar.")
  159.  
  160. ;;;###autoload
  161. (defvar all-christian-calendar-holidays nil
  162.   "*If nil, show only major holidays from the Christian calendar.
  163.  
  164. If nil, the only holidays from the Christian calendar shown will be those days
  165. of such major interest as to appear on secular calendars.
  166.  
  167. If t, the holidays shown in the calendar will include all special days that
  168. would be shown on a complete Christian calendar.")
  169.  
  170. ;;;###autoload
  171. (defvar all-islamic-calendar-holidays nil
  172.   "*If nil, show only major holidays from the Islamic calendar.
  173.  
  174. If nil, the only holidays from the Islamic calendar shown will be those days
  175. of such major interest as to appear on secular calendars.
  176.  
  177. If t, the holidays shown in the calendar will include all special days that
  178. would be shown on a complete Islamic calendar.")
  179.  
  180. ;;;###autoload
  181. (defvar calendar-load-hook nil
  182.   "*List of functions to be called after the calendar is first loaded.
  183. This is the place to add key bindings to calendar-mode-map.")
  184.  
  185. ;;;###autoload
  186. (defvar initial-calendar-window-hook nil
  187.   "*List of functions to be called when the calendar window is first opened.
  188. The functions invoked are called after the calendar window is opened, but
  189. once opened is never called again.  Leaving the calendar with the `q' command
  190. and reentering it will cause these functions to be called again.")
  191.  
  192. ;;;###autoload
  193. (defvar today-visible-calendar-hook nil
  194.   "*List of functions called whenever the current date is visible.
  195. This can be used, for example, to replace today's date with asterisks; a
  196. function `calendar-star-date' is included for this purpose:
  197.     (setq today-visible-calendar-hook 'calendar-star-date)
  198. It could also be used to mark the current date with `='; a function is also
  199. provided for this:
  200.     (setq today-visible-calendar-hook 'calendar-mark-today)
  201.  
  202. The corresponding variable `today-invisible-calendar-hook' is the list of
  203. functions called when the calendar function was called when the current
  204. date is not visible in the window.
  205.  
  206. Other than the use of the provided functions, the changing of any
  207. characters in the calendar buffer by the hooks may cause the failure of the
  208. functions that move by days and weeks.")
  209.  
  210. ;;;###autoload
  211. (defvar today-invisible-calendar-hook nil
  212.   "*List of functions called whenever the current date is not visible.
  213.  
  214. The corresponding variable `today-visible-calendar-hook' is the list of
  215. functions called when the calendar function was called when the current
  216. date is visible in the window.
  217.  
  218. Other than the use of the provided functions, the changing of any
  219. characters in the calendar buffer by the hooks may cause the failure of the
  220. functions that move by days and weeks.")
  221.  
  222. ;;;###autoload
  223. (defvar diary-file "~/diary"
  224.   "*Name of the file in which one's personal diary of dates is kept.
  225.  
  226. The file's entries are lines in any of the forms
  227.  
  228.             MONTH/DAY
  229.             MONTH/DAY/YEAR
  230.             MONTHNAME DAY
  231.             MONTHNAME DAY, YEAR
  232.             DAYNAME
  233.  
  234. at the beginning of the line; the remainder of the line is the diary entry
  235. string for that date.  MONTH and DAY are one or two digit numbers, YEAR is
  236. a number and may be written in full or abbreviated to the final two digits.
  237. If the date does not contain a year, it is generic and applies to any year.
  238. DAYNAME entries apply to any date on which is on that day of the week.
  239. MONTHNAME and DAYNAME can be spelled in full, abbreviated to three
  240. characters (with or without a period), capitalized or not.  Any of DAY,
  241. MONTH, or MONTHNAME, YEAR can be `*' which matches any day, month, or year,
  242. respectively.
  243.  
  244. The European style (in which the day precedes the month) can be used
  245. instead, if you execute `european-calendar' when in the calendar, or set
  246. `european-calendar-style' to t in your .emacs file.  The European forms are
  247.  
  248.             DAY/MONTH
  249.             DAY/MONTH/YEAR
  250.             DAY MONTHNAME
  251.             DAY MONTHNAME YEAR
  252.             DAYNAME
  253.  
  254. To revert to the default American style from the European style, execute
  255. `american-calendar' in the calendar.
  256.  
  257. A diary entry can be preceded by a diary-nonmarking-symbol (ordinarily `&')
  258. to make that entry nonmarking--that is, it will not be marked on dates in
  259. the calendar window but will appear in a diary window.
  260.  
  261. Multiline diary entries are made by indenting lines after the first with
  262. either a TAB or one or more spaces.
  263.  
  264. Lines not in one the above formats are ignored.  Here are some sample diary
  265. entries (in the default American style):
  266.  
  267.      12/22/1988 Twentieth wedding anniversary!!
  268.      &1/1. Happy New Year!
  269.      10/22 Ruth's birthday.
  270.      21: Payday
  271.      Tuesday--weekly meeting with grad students at 10am
  272.               Supowit, Shen, Bitner, and Kapoor to attend.
  273.      1/13/89 Friday the thirteenth!!
  274.      &thu 4pm squash game with Lloyd.
  275.      mar 16 Dad's birthday
  276.      April 15, 1989 Income tax due.
  277.      &* 15 time cards due.
  278.  
  279. If the first line of a diary entry consists only of the date or day name with
  280. no trailing blanks or punctuation, then that line will not be displayed in the
  281. diary window; only the continuation lines will be shown.  For example, the
  282. single diary entry
  283.  
  284.      02/11/1989
  285.       Bill Blattner visits Princeton today
  286.       2pm Cognitive Studies Committee meeting
  287.       2:30-5:30 Lizzie at Lawrenceville for `Group Initiative'
  288.       4:00pm Jamie Tappenden
  289.       7:30pm Dinner at George and Ed's for Alan Ryan
  290.       7:30-10:00pm dance at Stewart Country Day School
  291.  
  292. will appear in the diary window without the date line at the beginning.  This
  293. facility allows the diary window to look neater, but can cause confusion if
  294. used with more than one day's entries displayed.
  295.  
  296. Diary entries can be based on Lisp sexps.  For example, the diary entry
  297.  
  298.       %%(diary-block 11 1 1990 11 10 1990) Vacation
  299.  
  300. causes the diary entry \"Vacation\" to appear from November 1 through November
  301. 10, 1990.  Other functions available are `diary-float', `diary-anniversary',
  302. `diary-cyclic', `diary-day-of-year', `diary-iso-date', `diary-french-date',
  303. `diary-hebrew-date', `diary-islamic-date', `diary-mayan-date',
  304. `diary-yahrzeit', `diary-sunrise-sunset', `diary-phases-of-moon',
  305. `diary-parasha', `diary-omer', `diary-rosh-hodesh', and
  306. `diary-sabbath-candles'.  See the documentation for the function
  307. `list-sexp-diary-entries' for more details.
  308.  
  309. Diary entries based on the Hebrew and/or the Islamic calendar are also
  310. possible, but because these are somewhat slow, they are ignored
  311. unless you set the `nongregorian-diary-listing-hook' and the
  312. `nongregorian-diary-marking-hook' appropriately.  See the documentation
  313. for these functions for details.
  314.  
  315. Diary files can contain directives to include the contents of other files; for
  316. details, see the documentation for the variable `list-diary-entries-hook'.")
  317.  
  318. ;;;###autoload
  319. (defvar diary-nonmarking-symbol "&"
  320.   "*Symbol indicating that a diary entry is not to be marked in the calendar.")
  321.  
  322. ;;;###autoload
  323. (defvar hebrew-diary-entry-symbol "H"
  324.   "*Symbol indicating a diary entry according to the Hebrew calendar.")
  325.  
  326. ;;;###autoload
  327. (defvar islamic-diary-entry-symbol "I"
  328.   "*Symbol indicating a diary entry according to the Islamic calendar.")
  329.  
  330. ;;;###autoload
  331. (defvar diary-include-string "#include"
  332.   "*The string indicating inclusion of another file of diary entries.
  333. See the documentation for the function `include-other-diary-files'.")
  334.  
  335. ;;;###autoload
  336. (defvar sexp-diary-entry-symbol "%%"
  337.   "*The string used to indicate a sexp diary entry in diary-file.
  338. See the documentation for the function `list-sexp-diary-entries'.")
  339.  
  340. ;;;###autoload
  341. (defvar abbreviated-calendar-year t
  342.   "*Interpret a two-digit year DD in a diary entry as either 19DD or 20DD.
  343. For the Gregorian calendar; similarly for the Hebrew and Islamic calendars.
  344. If this variable is nil, years must be written in full.")
  345.  
  346. ;;;###autoload
  347. (defvar european-calendar-style nil
  348.   "*Use the European style of dates in the diary and in any displays.
  349. If this variable is t, a date 1/2/1990 would be interpreted as February 1,
  350. 1990.  The accepted European date styles are
  351.  
  352.             DAY/MONTH
  353.             DAY/MONTH/YEAR
  354.             DAY MONTHNAME
  355.             DAY MONTHNAME YEAR
  356.             DAYNAME
  357.  
  358. Names can be capitalized or not, written in full, or abbreviated to three
  359. characters with or without a period.")
  360.  
  361. ;;;###autoload
  362. (defvar american-date-diary-pattern
  363.   '((month "/" day "[^/0-9]")
  364.     (month "/" day "/" year "[^0-9]")
  365.     (monthname " *" day "[^,0-9]")
  366.     (monthname " *" day ", *" year "[^0-9]")
  367.     (dayname "\\W"))
  368.   "*List of pseudo-patterns describing the American patterns of date used.
  369. See the documentation of diary-date-forms for an explanation.")
  370.  
  371. ;;;###autoload
  372. (defvar european-date-diary-pattern
  373.   '((day "/" month "[^/0-9]")
  374.     (day "/" month "/" year "[^0-9]")
  375.     (backup day " *" monthname "\\W+\\<[^*0-9]")
  376.     (day " *" monthname " *" year "[^0-9]")
  377.     (dayname "\\W"))
  378.   "*List of pseudo-patterns describing the European patterns of date used.
  379. See the documentation of diary-date-forms for an explanation.")
  380.  
  381. ;;;###autoload
  382. (defvar diary-date-forms
  383.   (if european-calendar-style
  384.       european-date-diary-pattern
  385.     american-date-diary-pattern)
  386.   "*List of pseudo-patterns describing the forms of date used in the diary.
  387. The patterns on the list must be MUTUALLY EXCLUSIVE and must should not match
  388. any portion of the diary entry itself, just the date component.
  389.  
  390. A pseudo-pattern is a list of regular expressions and the keywords `month',
  391. `day', `year', `monthname', and `dayname'.  The keyword `monthname' will
  392. match the name of the month, capitalized or not, or its three-letter
  393. abbreviation, followed by a period or not; it will also match `*'.
  394. Similarly, `dayname' will match the name of the day, capitalized or not, or
  395. its three-letter abbreviation, followed by a period or not.  The keywords
  396. `month', `day', and `year' will match those numerical values, preceded by
  397. arbitrarily many zeros; they will also match `*'.
  398.  
  399. The matching of the diary entries with the date forms is done with the
  400. standard syntax table from Fundamental mode, but with the `*' changed so
  401. that it is a word constituent.
  402.  
  403. If, to be mutually exclusive, a pseudo-pattern must match a portion of the
  404. diary entry itself, the first element of the pattern MUST be `backup'.  This
  405. directive causes the date recognizer to back up to the beginning of the
  406. current word of the diary entry, so in no case can the pattern match more than
  407. a portion of the first word of the diary entry.")
  408.  
  409. ;;;###autoload
  410. (defvar european-calendar-display-form
  411.   '((if dayname (concat dayname ", ")) day " " monthname " " year)
  412.   "*Pseudo-pattern governing the way a date appears in the European style.
  413. See the documentation of calendar-date-display-forms for an explanation.")
  414.  
  415. ;;;###autoload
  416. (defvar american-calendar-display-form
  417.   '((if dayname (concat dayname ", ")) monthname " " day ", " year)
  418.   "*Pseudo-pattern governing the way a date appears in the American style.
  419. See the documentation of calendar-date-display-forms for an explanation.")
  420.  
  421. ;;;###autoload
  422. (defvar calendar-date-display-form
  423.   (if european-calendar-style
  424.       european-calendar-display-form
  425.     american-calendar-display-form)
  426.   "*Pseudo-pattern governing the way a date appears.
  427.  
  428. Used by the function `calendar-date-string', a pseudo-pattern is a list of
  429. expressions that can involve the keywords `month', `day', and `year', all
  430. numbers in string form, and `monthname' and `dayname', both alphabetic
  431. strings.  For example, the ISO standard would use the pseudo- pattern
  432.  
  433.        '(year \"-\" month \"-\" day)
  434.  
  435. while a typical American form would be
  436.  
  437.        '(month \"/\" day \"/\" (substring year -2))
  438.  
  439. and
  440.  
  441.        '((format \"%9s, %9s %2s, %4s\" dayname monthname day year))
  442.  
  443. would give the usual American style in fixed-length fields.
  444.  
  445. See the documentation of the function `calendar-date-string'.")
  446.  
  447. (defun european-calendar ()
  448.   "Set the interpretation and display of dates to the European style."
  449.   (interactive)
  450.   (setq european-calendar-style t)
  451.   (setq calendar-date-display-form european-calendar-display-form)
  452.   (setq diary-date-forms european-date-diary-pattern)
  453.   (update-calendar-mode-line))
  454.  
  455. (defun american-calendar ()
  456.   "Set the interpretation and display of dates to the American style."
  457.   (interactive)
  458.   (setq european-calendar-style nil)
  459.   (setq calendar-date-display-form american-calendar-display-form)
  460.   (setq diary-date-forms american-date-diary-pattern)
  461.   (update-calendar-mode-line))
  462.  
  463. ;;;###autoload
  464. (defvar print-diary-entries-hook 'lpr-buffer
  465.   "*List of functions called after a temporary diary buffer is prepared.
  466. The buffer shows only the diary entries currently visible in the diary
  467. buffer.  The default just does the printing.  Other uses might include, for
  468. example, rearranging the lines into order by day and time, saving the buffer
  469. instead of deleting it, or changing the function used to do the printing.")
  470.  
  471. ;;;###autoload
  472. (defvar list-diary-entries-hook nil
  473.   "*List of functions called after diary file is culled for relevant entries.
  474. It is to be used for diary entries that are not found in the diary file.
  475.  
  476. A function `include-other-diary-files' is provided for use as the value of
  477. this hook.  This function enables you to use shared diary files together
  478. with your own.  The files included are specified in the diary-file by lines
  479. of the form
  480.  
  481.         #include \"filename\"
  482.  
  483. This is recursive; that is, #include directives in files thus included are
  484. obeyed.  You can change the \"#include\" to some other string by changing
  485. the variable `diary-include-string'.  When you use `include-other-diary-files'
  486. as part of the list-diary-entries-hook, you will probably also want to use the
  487. function `mark-included-diary-files' as part of the mark-diary-entries-hook.
  488.  
  489. For example, you could use
  490.  
  491.      (setq list-diary-entries-hook
  492.        '(include-other-diary-files sort-diary-entries))
  493.      (setq diary-display-hook 'fancy-diary-display)
  494.  
  495. in your .emacs file to cause the fancy diary buffer to be displayed with
  496. diary entries from various included files, each day's entries sorted into
  497. lexicographic order.")
  498.  
  499. ;;;###autoload
  500. (defvar diary-display-hook 'simple-diary-display
  501.   "*List of functions that handle the display of the diary.
  502.  
  503. Ordinarily, this just displays the diary buffer (with holidays indicated in
  504. the mode line), if there are any relevant entries.  At the time these
  505. functions are called, the variable `diary-entries-list' is a list, in order
  506. by date, of all relevant diary entries in the form of ((MONTH DAY YEAR)
  507. STRING), where string is the diary entry for the given date.  This can be
  508. used, for example, to handle appointment notification, prepare a different
  509. buffer for display (perhaps combined with holidays), or produce hard copy
  510. output.
  511.  
  512. A function `fancy-diary-display' is provided as an alternative
  513. choice for this hook; this function prepares a special noneditable diary
  514. buffer with the relevant diary entries that has neat day-by-day arrangement
  515. with headings.  The fancy diary buffer will show the holidays unless the
  516. variable `holidays-in-diary-buffer' is set to nil.  Ordinarily, the fancy
  517. diary buffer will not show days for which there are no diary entries, even
  518. if that day is a holiday; if you want such days to be shown in the fancy
  519. diary buffer, set the variable `diary-list-include-blanks' to t.")
  520.  
  521. ;;;###autoload
  522. (defvar nongregorian-diary-listing-hook nil
  523.   "*List of functions called for listing diary file and included files.
  524. As the files are processed for diary entries, these functions are used to cull
  525. relevant entries.  You can use either or both of `list-hebrew-diary-entries'
  526. and `list-islamic-diary-entries'.  The documentation for these functions
  527. describes the style of such diary entries.")
  528.  
  529. ;;;###autoload
  530. (defvar mark-diary-entries-hook nil
  531.   "*List of functions called after marking diary entries in the calendar.
  532.  
  533. A function `mark-included-diary-files' is also provided for use as the
  534. mark-diary-entries-hook; it enables you to use shared diary files together
  535. with your own.  The files included are specified in the diary-file by lines
  536. of the form
  537.         #include \"filename\"
  538. This is recursive; that is, #include directives in files thus included are
  539. obeyed.  You can change the \"#include\" to some other string by changing the
  540. variable `diary-include-string'.  When you use `mark-included-diary-files' as
  541. part of the mark-diary-entries-hook, you will probably also want to use the
  542. function `include-other-diary-files' as part of the list-diary-entries-hook.")
  543.  
  544. ;;;###autoload
  545. (defvar nongregorian-diary-marking-hook nil
  546.   "*List of functions called for marking diary file and included files.
  547. As the files are processed for diary entries, these functions are used to cull
  548. relevant entries.  You can use either or both of `mark-hebrew-diary-entries'
  549. and `mark-islamic-diary-entries'.  The documentation for these functions
  550. describes the style of such diary entries.")
  551.  
  552. ;;;###autoload
  553. (defvar diary-list-include-blanks nil
  554.   "*If nil, do not include days with no diary entry in the list of diary entries.
  555. Such days will then not be shown in the the fancy diary buffer, even if they
  556. are holidays.")
  557.  
  558. ;;;###autoload
  559. (defvar holidays-in-diary-buffer t
  560.   "*If t, the holidays will be indicated in the diary display.
  561. The holidays will be given in the mode line of the diary buffer, or in the
  562. fancy diary buffer next to the date.  This slows down the diary functions
  563. somewhat; setting it to nil will make the diary display faster.")
  564.  
  565. (defvar calendar-mark-ring nil)
  566.  
  567. ;;;###autoload
  568. (defvar general-holidays
  569.   '((holiday-fixed 1 1 "New Year's Day")
  570.     (holiday-float 1 1 3 "Martin Luther King Day")
  571.     (holiday-fixed 2 2 "Ground Hog Day")
  572.     (holiday-fixed 2 14 "Valentine's Day")
  573.     (holiday-float 2 1 3 "President's Day")
  574.     (holiday-fixed 3 17 "St. Patrick's Day")
  575.     (holiday-fixed 4 1 "April Fool's Day")
  576.     (holiday-float 5 0 2 "Mother's Day")
  577.     (holiday-float 5 1 -1 "Memorial Day")
  578.     (holiday-fixed 6 14 "Flag Day")
  579.     (holiday-float 6 0 3 "Father's Day")
  580.     (holiday-fixed 7 4 "Independence Day")
  581.     (holiday-float 9 1 1 "Labor Day")
  582.     (holiday-float 10 1 2 "Columbus Day")
  583.     (holiday-fixed 10 31 "Halloween")
  584.     (holiday-fixed 11 11 "Veteran's Day")
  585.     (holiday-float 11 4 4 "Thanksgiving"))
  586.   "*General holidays.  Default value is for the United States.
  587. See the documentation for `calendar-holidays' for details.")
  588.  
  589. ;;;###autoload
  590. (defvar local-holidays nil
  591.   "*Local holidays.
  592. See the documentation for `calendar-holidays' for details.")
  593.  
  594. ;;;###autoload
  595. (defvar other-holidays nil
  596.   "*User defined holidays.
  597. See the documentation for `calendar-holidays' for details.")
  598.  
  599. ;;;###autoload
  600. (defvar hebrew-holidays
  601.   '((holiday-rosh-hashanah-etc)
  602.     (if all-hebrew-calendar-holidays
  603.         (holiday-julian
  604.          11
  605.          (let* ((m displayed-month)
  606.                 (y displayed-year)
  607.                 (year))
  608.            (increment-calendar-month m y -1)
  609.            (let ((year (extract-calendar-year
  610.                         (calendar-julian-from-absolute
  611.                          (calendar-absolute-from-gregorian
  612.                           (list m 1 y))))))
  613.              (if (zerop (% (1+ year) 4))
  614.                  22
  615.                21))) "\"Tal Umatar\" (evening)"))
  616.     (if all-hebrew-calendar-holidays
  617.         (holiday-hanukkah)
  618.       (holiday-hebrew 9 25 "Hanukkah"))
  619.     (if all-hebrew-calendar-holidays
  620.       (holiday-hebrew
  621.        10
  622.        (let ((h-year (extract-calendar-year
  623.                       (calendar-hebrew-from-absolute
  624.                        (calendar-absolute-from-gregorian
  625.                         (list displayed-month 28 displayed-year))))))
  626.          (if (= (% (calendar-absolute-from-hebrew (list 10 10 h-year))
  627.                    7)
  628.                 6)
  629.              11 10))
  630.        "Tzom Teveth"))
  631.     (if all-hebrew-calendar-holidays
  632.         (holiday-hebrew 11 15 "Tu B'Shevat"))
  633.     (if all-hebrew-calendar-holidays
  634.         (holiday-hebrew
  635.          11
  636.          (let ((m displayed-month)
  637.                (y displayed-year))
  638.            (increment-calendar-month m y 1)
  639.            (let* ((h-year (extract-calendar-year
  640.                            (calendar-hebrew-from-absolute
  641.                             (calendar-absolute-from-gregorian
  642.                              (list m
  643.                                    (calendar-last-day-of-month m y)
  644.                                    y)))))
  645.                   (s-s
  646.                    (calendar-hebrew-from-absolute
  647.                     (if (=
  648.                          (% (calendar-absolute-from-hebrew
  649.                              (list 7 1 h-year))
  650.                             7)
  651.                          6)
  652.                         (calendar-dayname-on-or-before
  653.                          6 (calendar-absolute-from-hebrew
  654.                             (list 11 17 h-year)))
  655.                       (calendar-dayname-on-or-before
  656.                        6 (calendar-absolute-from-hebrew
  657.                           (list 11 16 h-year))))))
  658.                   (day (extract-calendar-day s-s)))
  659.              day))
  660.          "Shabbat Shirah"))
  661.     (holiday-passover-etc)
  662.     (if (and all-hebrew-calendar-holidays
  663.              (let* ((m displayed-month)
  664.                     (y displayed-year)
  665.                     (year))
  666.                (increment-calendar-month m y -1)
  667.                (let ((year (extract-calendar-year
  668.                             (calendar-julian-from-absolute
  669.                              (calendar-absolute-from-gregorian
  670.                               (list m 1 y))))))
  671.                  (= 21 (% year 28)))))
  672.         (holiday-julian 3 26 "Kiddush HaHamah"))
  673.     (if all-hebrew-calendar-holidays
  674.         (holiday-tisha-b-av-etc)))
  675.   "*Jewish holidays.
  676. See the documentation for `calendar-holidays' for details.")
  677.  
  678. ;;;###autoload
  679. (defvar christian-holidays
  680.   '((if all-christian-calendar-holidays
  681.         (holiday-fixed 1 6 "Epiphany"))
  682.     (holiday-easter-etc)
  683.     (if all-christian-calendar-holidays
  684.         (holiday-greek-orthodox-easter))
  685.     (if all-christian-calendar-holidays
  686.         (holiday-fixed 8 15 "Assumption"))
  687.     (if all-christian-calendar-holidays
  688.         (holiday-advent))
  689.     (holiday-fixed 12 25 "Christmas")
  690.     (if all-christian-calendar-holidays
  691.         (holiday-julian 12 25 "Eastern Orthodox Christmas")))
  692.   "*Christian holidays.
  693. See the documentation for `calendar-holidays' for details.")
  694.  
  695. ;;;###autoload
  696. (defvar islamic-holidays
  697.   '((holiday-islamic
  698.      1 1
  699.      (format "Islamic New Year %d"
  700.              (let ((m displayed-month)
  701.                    (y displayed-year))
  702.                (increment-calendar-month m y 1)
  703.                (extract-calendar-year
  704.                 (calendar-islamic-from-absolute
  705.                  (calendar-absolute-from-gregorian
  706.                   (list
  707.                    m (calendar-last-day-of-month m y) y)))))))
  708.     (if all-islamic-calendar-holidays
  709.         (holiday-islamic 1 10 "Ashura"))
  710.     (if all-islamic-calendar-holidays
  711.         (holiday-islamic 3 12 "Mulad-al-Nabi"))
  712.     (if all-islamic-calendar-holidays
  713.         (holiday-islamic 7 26 "Shab-e-Mi'raj"))
  714.     (if all-islamic-calendar-holidays
  715.         (holiday-islamic 8 15 "Shab-e-Bara't"))
  716.     (holiday-islamic 9 1 "Ramadan Begins")
  717.     (if all-islamic-calendar-holidays
  718.         (holiday-islamic 9 27 "Shab-e Qadr"))
  719.     (if all-islamic-calendar-holidays
  720.         (holiday-islamic 10 1 "Id-al-Fitr"))
  721.     (if all-islamic-calendar-holidays
  722.         (holiday-islamic 12 10 "Id-al-Adha")))
  723.   "*Islamic holidays.
  724. See the documentation for `calendar-holidays' for details.")
  725.  
  726. ;;;###autoload
  727. (defvar solar-holidays
  728.   '((if (fboundp 'atan)
  729.     (solar-equinoxes-solstices))
  730.     (progn
  731.       (require 'cal-dst)
  732.       (funcall
  733.        'holiday-sexp 
  734.         calendar-daylight-savings-starts
  735.         '(format "Daylight Savings Time Begins %s"
  736.                   (if (fboundp 'atan)
  737.                       (solar-time-string
  738.                        (/ calendar-daylight-savings-switchover-time
  739.                           (float 60))
  740.                        date
  741.                        'standard)
  742.                     ""))))
  743.     (funcall
  744.      'holiday-sexp
  745.      calendar-daylight-savings-ends
  746.      '(format "Daylight Savings Time Ends %s"
  747.               (if (fboundp 'atan)
  748.                   (solar-time-string
  749.                    (/ (- calendar-daylight-savings-switchover-time
  750.                          calendar-daylight-time-offset)
  751.                       (float 60))
  752.                    date
  753.                    'daylight)
  754.                 ""))))
  755.   "*Sun-related holidays.
  756. See the documentation for `calendar-holidays' for details.")
  757.  
  758. ;;;###autoload
  759. (defvar calendar-holidays
  760.   (append general-holidays local-holidays other-holidays
  761.           christian-holidays hebrew-holidays islamic-holidays
  762.           solar-holidays)
  763.   "*List of notable days for the command M-x holidays.
  764.  
  765. Additional holidays are easy to add to the list, just put them in the list
  766. `other-holidays' in your .emacs file.  Similarly, by setting any of
  767. `general-holidays', `local-holidays' `christian-holidays', `hebrew-holidays',
  768. `islamic-holidays', or `solar-holidays' to nil in your .emacs file, you can
  769. eliminate unwanted categories of holidays.  The intention is that (in the US)
  770. `local-holidays' be set in site-init.el and `other-holidays' be set by the
  771. user.
  772.  
  773. Entries on the list are expressions that return (possibly empty) lists of
  774. items of the form ((month day year) string) of a holiday in the in the
  775. three-month period centered around `displayed-month' of `displayed-year'.
  776. Several basic functions are provided for this purpose:
  777.  
  778.     (holiday-fixed MONTH DAY STRING) is a fixed date on the Gregorian calendar
  779.     (holiday-float MONTH DAYNAME K STRING &optional day) is the Kth DAYNAME in
  780.                                MONTH on the Gregorian calendar (0 for Sunday,
  781.                                etc.); K<0 means count back from the end of the
  782.                                month. An optional parameter DAY means the Kth
  783.                                DAYNAME after/before MONTH DAY.
  784.     (holiday-hebrew MONTH DAY STRING)  a fixed date on the Hebrew calendar
  785.     (holiday-islamic MONTH DAY STRING) a fixed date on the Islamic calendar
  786.     (holiday-julian MONTH DAY STRING)  a fixed date on the Julian calendar
  787.     (holiday-sexp SEXP STRING) SEXP is a Gregorian-date-valued expression
  788.                                in the variable `year'; if it evaluates to
  789.                                a visible date, that's the holiday; if it
  790.                                evaluates to nil, there's no holiday.  STRING
  791.                                is an expression in the variable `date'.
  792.  
  793. For example, to add Bastille Day, celebrated in France on July 14, add
  794.  
  795.      (holiday-fixed 7 14 \"Bastille Day\")
  796.  
  797. to the list.  To add Hurricane Supplication Day, celebrated in the Virgin
  798. Islands on the fourth Monday in August, add
  799.  
  800.      (holiday-float 8 1 4 \"Hurricane Supplication Day\")
  801.  
  802. to the list (the last Monday would be specified with `-1' instead of `4').
  803. To add the last day of Hanukkah to the list, use
  804.  
  805.      (holiday-hebrew 10 2 \"Last day of Hanukkah\")
  806.  
  807. since the Hebrew months are numbered with 1 starting from Nisan, while to
  808. add the Islamic feast celebrating Mohammed's birthday use
  809.  
  810.      (holiday-islamic 3 12 \"Mohammed's Birthday\")
  811.  
  812. since the Islamic months are numbered from 1 starting with Muharram.  To
  813. add Thomas Jefferson's birthday, April 2, 1743 (Julian), use
  814.  
  815.      (holiday-julian 4 2 \"Jefferson's Birthday\")
  816.  
  817. To include a holiday conditionally, use the sexp form or a conditional.  For
  818. example, to include American presidential elections, which occur on the first
  819. Tuesday after the first Monday in November of years divisible by 4, add
  820.  
  821.      (holiday-sexp
  822.        (if (zerop (% year 4))
  823.            (calendar-gregorian-from-absolute
  824.              (1+ (calendar-dayname-on-or-before
  825.                    1 (+ 6 (calendar-absolute-from-gregorian
  826.                             (list 11 1 year)))))))
  827.        \"US Presidential Election\")
  828.  
  829. or
  830.  
  831.      (if (zerop (% displayed-year 4))
  832.          (holiday-fixed 11
  833.                 (extract-calendar-day
  834.                  (calendar-gregorian-from-absolute
  835.                   (1+ (calendar-dayname-on-or-before
  836.                        1 (+ 6 (calendar-absolute-from-gregorian
  837.                                (list 11 1 displayed-year)))))))
  838.                 \"US Presidential Election\"))
  839.  
  840. to the list.  To include the phases of the moon, add
  841.  
  842.      (lunar-phases)
  843.  
  844. to the holiday list, where `lunar-phases' is an Emacs-Lisp function that
  845. you've written to return a (possibly empty) list of the relevant VISIBLE dates
  846. with descriptive strings such as
  847.  
  848.      (((2 6 1989) \"New Moon\") ((2 12 1989) \"First Quarter Moon\") ... ).")
  849.  
  850. (defconst calendar-buffer "*Calendar*"
  851.   "Name of the buffer used for the calendar.")
  852.  
  853. (defconst holiday-buffer "*Holidays*"
  854.   "Name of the buffer used for the displaying the holidays.")
  855.  
  856. (defconst fancy-diary-buffer "*Fancy Diary Entries*"
  857.   "Name of the buffer used for the optional fancy display of the diary.")
  858.  
  859. (defmacro increment-calendar-month (mon yr n)
  860.   "Move the variables MON and YR to the month and year by N months.
  861. Forward if N is positive or backward if N is negative."
  862.   (` (let (( macro-y (+ (* (, yr) 12) (, mon) -1 (, n) )))
  863.        (setq (, mon) (1+ (% macro-y 12) ))
  864.        (setq (, yr) (/ macro-y 12)))))
  865.  
  866. (defmacro calendar-for-loop (var from init to final do &rest body)
  867.   "Execute a for loop."
  868.   (` (let (( (, var) (1- (, init)) ))
  869.        (while (>= (, final) (setq (, var) (1+ (, var))))
  870.          (,@ body)))))
  871.  
  872. (defmacro calendar-sum (index initial condition expression)
  873.   "For INDEX = INITIAL et seq, as long as CONDITION holds, sum EXPRESSION."
  874.   (` (let (( (, index) (, initial))
  875.              (sum 0))
  876.        (while (, condition)
  877.          (setq sum (+ sum (, expression) ))
  878.          (setq (, index) (1+ (, index))))
  879.        sum)))
  880.  
  881. ;; The following macros are for speed; the code would be clearer if they
  882. ;; were functions, but they can be called thousands of times when
  883. ;; looking up holidays or processing the diary.  Here, for example, are the
  884. ;; numbers of calls to calendar/diary/holiday functions in preparing the
  885. ;; fancy diary display, for a moderately complex diary file, with functions
  886. ;; used instead of macros.  There were a total of 10000 such calls:
  887. ;;
  888. ;;  1934   extract-calendar-month
  889. ;;  1852   extract-calendar-year
  890. ;;  1819   extract-calendar-day
  891. ;;   845   calendar-leap-year-p
  892. ;;   837   calendar-day-number
  893. ;;   775   calendar-absolute-from-gregorian
  894. ;;   346   calendar-last-day-of-month
  895. ;;   286   hebrew-calendar-last-day-of-month
  896. ;;   188   hebrew-calendar-leap-year-p
  897. ;;   180   hebrew-calendar-elapsed-days
  898. ;;   163   hebrew-calendar-last-month-of-year
  899. ;;    66   calendar-date-compare
  900. ;;    65   hebrew-calendar-days-in-year
  901. ;;    60   calendar-absolute-from-julian
  902. ;;    50   calendar-absolute-from-hebrew
  903. ;;    43   calendar-date-equal
  904. ;;    38   calendar-gregorian-from-absolute
  905. ;;     .
  906. ;;     .
  907. ;;     .
  908. ;;
  909. ;; The use of these seven macros eliminates the overhead of 92% of the function
  910. ;; calls; it's faster this way.  For clarity, the defun form of each is given
  911. ;; in comments after the defmacro form.
  912.  
  913. (defmacro extract-calendar-month (date)
  914.   "Extract the month part of DATE which has the form (month day year)."
  915.   (` (car (, date))))
  916. ;;(defun extract-calendar-month (date)
  917. ;;  "Extract the month part of DATE which has the form (month day year)."
  918. ;;  (car date))
  919.  
  920. (defmacro extract-calendar-day (date)
  921.   "Extract the day part of DATE which has the form (month day year)."
  922.   (` (car (cdr (, date)))))
  923. ;;(defun extract-calendar-day (date)
  924. ;;  "Extract the day part of DATE which has the form (month day year)."
  925. ;;  (car (cdr date)))
  926.  
  927. (defmacro extract-calendar-year (date)
  928.   "Extract the year part of DATE which has the form (month day year)."
  929.   (` (car (cdr (cdr (, date))))))
  930. ;;(defun extract-calendar-year (date)
  931. ;;  "Extract the year part of DATE which has the form (month day year)."
  932. ;;  (car (cdr (cdr date))))
  933.  
  934. (defmacro calendar-leap-year-p (year)
  935.   "Returns t if YEAR is a Gregorian leap year."
  936.   (` (and
  937.     (zerop (% (, year) 4))
  938.     (or (not (zerop (% (, year) 100)))
  939.         (zerop (% (, year) 400))))))
  940. ;;(defun calendar-leap-year-p (year)
  941. ;;  "Returns t if YEAR is a Gregorian leap year."
  942. ;;  (and
  943. ;;    (zerop (% year 4))
  944. ;;    (or ((not (zerop (% year 100))))
  945. ;;      (zerop (% year 400)))))
  946. ;;
  947. ;; The foregoing is a bit faster, but not as clear as the following:
  948. ;;
  949. ;;(defmacro calendar-leap-year-p (year)
  950. ;;  "Returns t if YEAR is a Gregorian leap year."
  951. ;;  (` (or
  952. ;;        (and (=  (% (, year) 4) 0)
  953. ;;             (/= (% (, year) 100) 0))
  954. ;;        (= (% (, year) 400) 0))))
  955. ;;(defun calendar-leap-year-p (year)
  956. ;;  "Returns t if YEAR is a Gregorian leap year."
  957. ;;  (or
  958. ;;    (and (=  (% year   4) 0)
  959. ;;         (/= (% year 100) 0))
  960. ;;    (= (% year 400) 0)))
  961.  
  962. (defmacro calendar-last-day-of-month (month year)
  963.   "The last day in MONTH during YEAR."
  964.   (` (if (and
  965.             (, (macroexpand (` (calendar-leap-year-p (, year)))))
  966.             (= (, month) 2))
  967.            29
  968.          (aref [31 28 31 30 31 30 31 31 30 31 30 31] (1- (, month))))))
  969. ;;(defun calendar-last-day-of-month (month year)
  970. ;;  "The last day in MONTH during YEAR."
  971. ;;  (if (and (calendar-leap-year-p year) (= month 2))
  972. ;;      29
  973. ;;    (aref [31 28 31 30 31 30 31 31 30 31 30 31] (1- month))))
  974.  
  975. (defmacro calendar-day-number (date)
  976.   "Return the day number within the year of the date DATE.
  977. For example, (calendar-day-number '(1 1 1987)) returns the value 1,
  978. while (calendar-day-number '(12 31 1980)) returns 366."
  979. ;;
  980. ;; An explanation of the calculation can be found in PascAlgorithms by
  981. ;; Edward and Ruth Reingold, Scott-Foresman/Little, Brown, 1988.
  982. ;;
  983.   (` (let* ((month (, (macroexpand (` (extract-calendar-month (, date))))))
  984.             (day (, (macroexpand (` (extract-calendar-day (, date))))))
  985.             (year  (, (macroexpand (` (extract-calendar-year (, date))))))
  986.             (day-of-year (+ day (* 31 (1- month)))))
  987.        (if (> month 2)
  988.            (progn
  989.              (setq day-of-year (- day-of-year (/ (+ 23 (* 4 month)) 10)))
  990.             (if (, (macroexpand (` (calendar-leap-year-p year))))
  991.                 (setq day-of-year (1+ day-of-year)))))
  992.        day-of-year)))
  993. ;;(defun calendar-day-number (date)
  994. ;;  "Return the day number within the year of the date DATE.
  995. ;;For example, (calendar-day-number '(1 1 1987)) returns the value 1,
  996. ;;while (calendar-day-number '(12 31 1980)) returns 366."
  997. ;;    (let* ((month (extract-calendar-month date))
  998. ;;           (day (extract-calendar-day date))
  999. ;;           (year (extract-calendar-year date))
  1000. ;;         (day-of-year (+ day (* 31 (1- month)))))
  1001. ;;      (if (> month 2)
  1002. ;;          (progn
  1003. ;;            (setq day-of-year (- day-of-year (/ (+ 23 (* 4 month)) 10)))
  1004. ;;            (if (calendar-leap-year-p year)
  1005. ;;                (setq day-of-year (1+ day-of-year)))))
  1006. ;;      day-of-year))
  1007.  
  1008. (defmacro calendar-absolute-from-gregorian (date)
  1009.   "The number of days elapsed between the Gregorian date 12/31/1 BC and DATE.
  1010. The Gregorian date Sunday, December 31, 1 BC is imaginary."
  1011.   (` (let ((year  (, (macroexpand (` (extract-calendar-year (, date)))))))
  1012.        (+ (, (macroexpand (` (calendar-day-number (, date)))));; Days this year
  1013.           (* 365 (1- year));;        + Days in prior years
  1014.           (/ (1- year) 4);;          + Julian leap years
  1015.           (- (/ (1- year) 100));;    - century years
  1016.           (/ (1- year) 400)))));;     + Gregorian leap years
  1017. ;;(defun calendar-absolute-from-gregorian (date)
  1018. ;;  "The number of days elapsed between the Gregorian date 12/31/1 BC and DATE.
  1019. ;;The Gregorian date Sunday, December 31, 1 BC is imaginary."
  1020. ;;  (let ((year (extract-calendar-year date)))
  1021. ;;    (+ (calendar-day-number date);; Days this year
  1022. ;;       (* 365 (1- year));;        + Days in prior years
  1023. ;;       (/ (1- year) 4);;          + Julian leap years
  1024. ;;       (- (/ (1- year) 100));;    - century years
  1025. ;;       (/ (1- year) 400))));;     + Gregorian leap years
  1026.  
  1027. ;;;###autoload
  1028. (defun calendar (&optional arg)
  1029.   "Display a three-month calendar in another window.
  1030. The three months appear side by side, with the current month in the middle
  1031. surrounded by the previous and next months.  The cursor is put on today's date.
  1032.  
  1033. If called with an optional prefix argument, prompts for month and year.
  1034.  
  1035. This function is suitable for execution in a .emacs file; appropriate setting
  1036. of the variable `view-diary-entries-initially' will cause the diary entries for
  1037. the current date to be displayed in another window.  The value of the variable
  1038. `number-of-diary-entries' controls the number of days of diary entries
  1039. displayed upon initial display of the calendar.
  1040.  
  1041. An optional prefix argument ARG causes the calendar displayed to be ARG
  1042. months in the future if ARG is positive or in the past if ARG is negative;
  1043. in this case the cursor goes on the first day of the month.
  1044.  
  1045. Once in the calendar window, future or past months can be moved into view.
  1046. Arbitrary months can be displayed, or the calendar can be scrolled forward
  1047. or backward.
  1048.  
  1049. The cursor can be moved forward or backward by one day, one week, one month,
  1050. or one year.  All of these commands take prefix arguments which, when negative,
  1051. cause movement in the opposite direction.  For convenience, the digit keys
  1052. and the minus sign are automatically prefixes.  The window is replotted as
  1053. necessary to display the desired date.
  1054.  
  1055. Diary entries can be marked on the calendar or displayed in another window.
  1056.  
  1057. Use M-x describe-mode for details of the key bindings in the calendar window.
  1058.  
  1059. The Gregorian calendar is assumed.
  1060.  
  1061. After loading the calendar, the hooks given by the variable
  1062. `calendar-load-hook' are run.  This the place to add key bindings to the
  1063. calendar-mode-map.
  1064.  
  1065. After preparing the calendar window initially, the hooks given by the variable
  1066. `initial-calendar-window-hook' are run.
  1067.  
  1068. The hooks given by the variable `today-visible-calendar-hook' are run
  1069. everytime the calendar window gets scrolled, if the current date is visible
  1070. in the window.  If it is not visible, the hooks given by the variable
  1071. `today-invisible-calendar-hook' are run.  Thus, for example, setting
  1072. `today-visible-calendar-hook' to 'calendar-star-date will cause today's date
  1073. to be replaced by asterisks to highlight it whenever it is in the window."
  1074.   (interactive "P")
  1075.   (set-buffer (get-buffer-create calendar-buffer))
  1076.   (calendar-mode)
  1077.   (setq calendar-window-configuration (current-window-configuration))
  1078.   (let* ((completion-ignore-case t)
  1079.          (pop-up-windows t)
  1080.          (split-height-threshold 1000)
  1081.          (date (calendar-current-date))
  1082.          (month
  1083.           (if arg
  1084.               (cdr (assoc
  1085.                     (capitalize
  1086.                      (completing-read
  1087.                       "Month name: "
  1088.                       (mapcar 'list (append calendar-month-name-array nil))
  1089.                       nil t))
  1090.                     (calendar-make-alist calendar-month-name-array)))
  1091.             (extract-calendar-month date)))
  1092.          (year
  1093.           (if arg
  1094.               (calendar-read
  1095.                "Year (>0): "
  1096.                '(lambda (x) (> x 0))
  1097.                (int-to-string (extract-calendar-year date)))
  1098.             (extract-calendar-year date))))
  1099.     (pop-to-buffer calendar-buffer)
  1100.     (generate-calendar-window month year)
  1101.     (if (and view-diary-entries-initially (calendar-date-is-visible-p date))
  1102.         (view-diary-entries
  1103.          (if (vectorp number-of-diary-entries)
  1104.              (aref number-of-diary-entries (calendar-day-of-week date))
  1105.            number-of-diary-entries))))
  1106.   (let* ((diary-buffer (get-file-buffer diary-file))
  1107.          (diary-window (if diary-buffer (get-buffer-window diary-buffer)))
  1108.          (split-height-threshold (if diary-window 2 1000)))
  1109.     (if view-calendar-holidays-initially
  1110.         (list-calendar-holidays)))
  1111.   (run-hooks 'initial-calendar-window-hook))
  1112.  
  1113. (autoload 'view-diary-entries "diary"
  1114.   "Prepare and display a buffer with diary entries.
  1115. Searches the file diary-file for entries that match ARG days starting with
  1116. the date indicated by the cursor position in the displayed three-month
  1117. calendar."
  1118.   t)
  1119.  
  1120. (autoload 'calendar-sunrise-sunset "solar"
  1121.   "Local time of sunrise and sunset for date under cursor."
  1122.   t)
  1123.  
  1124. (autoload 'calendar-phases-of-moon "lunar"
  1125.   "Create a buffer of the phases of the moon for the current calendar window."
  1126.   t)
  1127.  
  1128. (autoload 'calendar-print-french-date "cal-french"
  1129.   "Show the French Revolutionary calendar equivalent of the date under the
  1130. cursor."
  1131.   t)
  1132.  
  1133. (autoload 'calendar-goto-french-date "cal-french"
  1134.  "Move cursor to French Revolutionary date."
  1135.   t)
  1136.  
  1137. (autoload 'calendar-print-mayan-date "cal-mayan"
  1138.   "Show the Mayan long count, Tzolkin, and Haab equivalents of the date
  1139. under the cursor."
  1140.   t)
  1141.  
  1142. (autoload 'calendar-goto-mayan-long-count-date "cal-mayan"
  1143.  "Move cursor to Mayan long count date."
  1144.   t)
  1145.  
  1146. (autoload 'calendar-next-haab-date "cal-mayan"
  1147.   "Move cursor to next instance of Mayan Haab date."
  1148.   t)
  1149.  
  1150. (autoload 'calendar-previous-haab-date "cal-mayan"
  1151.   "Move cursor to previous instance of Mayan Haab date."
  1152.   t)
  1153.  
  1154. (autoload 'calendar-next-tzolkin-date "cal-mayan"
  1155.   "Move cursor to next instance of Mayan Tzolkin date."
  1156.   t)
  1157.  
  1158. (autoload 'calendar-previous-tzolkin-date "cal-mayan"
  1159.   "Move cursor to previous instance of Mayan Tzolkin date."
  1160.   t)
  1161.  
  1162. (autoload 'calendar-next-calendar-round-date "cal-mayan"
  1163.   "Move cursor to next instance of Mayan Haab/Tzoklin combination."
  1164.   t)
  1165.  
  1166. (autoload 'calendar-previous-calendar-round-date "cal-mayan"
  1167.   "Move cursor to previous instance of Mayan Haab/Tzoklin combination."
  1168.   t)
  1169.  
  1170. (autoload 'show-all-diary-entries "diary"
  1171.   "Show all of the diary entries in the diary-file.
  1172. This function gets rid of the selective display of the diary-file so that
  1173. all entries, not just some, are visible.  If there is no diary buffer, one
  1174. is created."
  1175.   t)
  1176.  
  1177. (autoload 'mark-diary-entries "diary"
  1178.   "Mark days in the calendar window that have diary entries.
  1179. Each entry in diary-file visible in the calendar window is marked."
  1180.   t)
  1181.  
  1182. (autoload 'insert-diary-entry "diary-ins"
  1183.   "Insert a diary entry for the date indicated by point."
  1184.   t)
  1185.  
  1186. (autoload 'insert-weekly-diary-entry "diary-ins"
  1187.   "Insert a weekly diary entry for the day of the week indicated by point."
  1188.   t)
  1189.  
  1190.  
  1191. (autoload 'insert-monthly-diary-entry "diary-ins"
  1192.   "Insert a monthly diary entry for the day of the month indicated by point."
  1193.   t)
  1194.  
  1195. (autoload 'insert-yearly-diary-entry "diary-ins"
  1196.   "Insert an annual diary entry for the day of the year indicated by point."
  1197.   t)
  1198.  
  1199. (autoload 'insert-anniversary-diary-entry "diary-ins"
  1200.   "Insert an anniversary diary entry for the date indicated by point."
  1201.   t)
  1202.  
  1203. (autoload 'insert-block-diary-entry "diary-ins"
  1204.   "Insert a block diary entry for the dates indicated by point and mark."
  1205.   t)
  1206.  
  1207. (autoload 'insert-cyclic-diary-entry "diary-ins"
  1208.   "Insert a cyclic diary entry starting at the date indicated by point."
  1209.   t)
  1210.  
  1211. (autoload 'insert-hebrew-diary-entry "diary-ins"
  1212.   "Insert a diary entry for the Hebrew date corresponding to the date
  1213. indicated by point."
  1214.   t)
  1215.  
  1216. (autoload 'insert-monthly-hebrew-diary-entry "diary-ins"
  1217.   "Insert a monthly diary entry for the day of the Hebrew month corresponding
  1218. to the date indicated by point."
  1219.   t)
  1220.  
  1221. (autoload 'insert-yearly-hebrew-diary-entry "diary-ins"
  1222.   "Insert an annual diary entry for the day of the Hebrew year corresponding
  1223. to the date indicated by point."
  1224.   t)
  1225.  
  1226. (autoload 'insert-islamic-diary-entry "diary-ins"
  1227.   "Insert a diary entry for the Islamic date corresponding to the date
  1228. indicated by point."
  1229.   t)
  1230.  
  1231. (autoload 'insert-monthly-islamic-diary-entry "diary-ins"
  1232.   "Insert a monthly diary entry for the day of the Islamic month corresponding
  1233. to the date indicated by point."
  1234.   t)
  1235.  
  1236. (autoload 'insert-yearly-islamic-diary-entry "diary-ins"
  1237.   "Insert an annual diary entry for the day of the Islamic year corresponding
  1238. to the date indicated by point."
  1239.   t)
  1240.  
  1241. (autoload 'list-calendar-holidays "holidays"
  1242.   "Create a buffer containing the holidays for the current calendar window.
  1243. The holidays are those in the list `calendar-notable-days'.  Returns t if any
  1244. holidays are found, nil if not."
  1245.   t)
  1246.  
  1247. (autoload 'mark-calendar-holidays "holidays"
  1248.   "Mark notable days in the calendar window."
  1249.   t)
  1250.  
  1251. (autoload 'calendar-cursor-holidays "holidays"
  1252.   "Find holidays for the date specified by the cursor in the calendar window."
  1253.   t)
  1254.  
  1255. (defun generate-calendar-window (&optional mon yr)
  1256.   "Generate the calendar window for the current date.
  1257. Or, for optional MON, YR."
  1258.   (let* ((buffer-read-only nil)
  1259.          (today (calendar-current-date))
  1260.          (month (extract-calendar-month today))
  1261.          (day (extract-calendar-day today))
  1262.          (year (extract-calendar-year today))
  1263.          (today-visible
  1264.           (or (not mon)
  1265.               (let ((offset (calendar-interval mon yr month year)))
  1266.                 (and (<= offset 1) (>= offset -1)))))
  1267.          (day-in-week (calendar-day-of-week today)))
  1268.     (update-calendar-mode-line)
  1269.     (if mon
  1270.         (generate-calendar mon yr)
  1271.         (generate-calendar month year))
  1272.     (calendar-cursor-to-visible-date
  1273.      (if today-visible today (list displayed-month 1 displayed-year)))
  1274.     (set-buffer-modified-p nil)
  1275.     (or (one-window-p t)
  1276.         (/= (frame-width) (window-width))
  1277.         (shrink-window (- (window-height) 9)))
  1278.     (sit-for 0)
  1279.     (and mark-holidays-in-calendar
  1280.          (mark-calendar-holidays)
  1281.          (sit-for 0))
  1282.     (unwind-protect
  1283.         (if mark-diary-entries-in-calendar (mark-diary-entries))
  1284.       (if today-visible
  1285.           (run-hooks 'today-visible-calendar-hook)
  1286.         (run-hooks 'today-invisible-calendar-hook)))))
  1287.  
  1288. (defun generate-calendar (month year)
  1289.   "Generate a three-month Gregorian calendar centered around MONTH, YEAR."
  1290.   (if (< (+ month (* 12 (1- year))) 2)
  1291.       (error "Months before February, 1 AD are not available."))
  1292.   (setq displayed-month month)
  1293.   (setq displayed-year year)
  1294.   (erase-buffer)
  1295.   (increment-calendar-month month year -1)
  1296.   (calendar-for-loop i from 0 to 2 do
  1297.        (generate-calendar-month month year (+ 5 (* 25 i)))
  1298.        (increment-calendar-month month year 1)))
  1299.  
  1300. (defun generate-calendar-month (month year indent)
  1301.   "Produce a calendar for MONTH, YEAR on the Gregorian calendar.
  1302. The calendar is inserted in the buffer starting at the line on which point
  1303. is currently located, but indented INDENT spaces.  The indentation is done
  1304. from the first character on the line and does not disturb the first INDENT
  1305. characters on the line."
  1306.   (let* ((first-day-of-month (calendar-day-of-week (list month 1 year)))
  1307.          (first-saturday (- 7 first-day-of-month))
  1308.          (last (calendar-last-day-of-month month year))
  1309.          (heading (format "%s %d" (calendar-month-name month) year)))
  1310.     (goto-char (point-min))
  1311.     (calendar-insert-indented
  1312.      heading (+ indent (/ (- 20 (length heading)) 2)) t)
  1313.     (calendar-insert-indented " S  M Tu  W Th  F  S" indent t)
  1314.     (calendar-insert-indented "" indent);; Move to appropriate spot on line
  1315.     ;; Add blank days before the first of the month
  1316.     (calendar-for-loop i from 1 to first-day-of-month do
  1317.         (insert "   "))
  1318.     ;; Put in the days of the month
  1319.     (calendar-for-loop i from 1 to last do
  1320.          (insert (format "%2d " i))
  1321.          (and (= (% i 7) (% first-saturday 7))
  1322.               (/= i last)
  1323.               (calendar-insert-indented "" 0 t)    ;; Force onto following line
  1324.               (calendar-insert-indented "" indent)))));; Go to proper spot
  1325.  
  1326. (defun calendar-insert-indented (string indent &optional newline)
  1327.   "Insert STRING at column INDENT.
  1328. If the optional parameter NEWLINE is t, leave point at start of next line,
  1329. inserting a newline if there was no next line; otherwise, leave point after
  1330. the inserted text.  Value is always t."
  1331.   ;; Try to move to that column.
  1332.   (move-to-column indent)
  1333.   ;; If line is too short, indent out to that column.
  1334.   (if (< (current-column) indent)
  1335.       (indent-to indent))
  1336.   (insert string)
  1337.   ;; Advance to next line, if requested.
  1338.   (if newline
  1339.       (progn
  1340.     (end-of-line)
  1341.     (if (eobp)
  1342.             (newline)
  1343.       (forward-line 1))))
  1344.   t)
  1345.  
  1346. (defun redraw-calendar ()
  1347.   "Redraw the calendar display."
  1348.   (interactive)
  1349.   (let ((cursor-date (calendar-cursor-to-date)))
  1350.     (generate-calendar-window displayed-month displayed-year)
  1351.     (calendar-cursor-to-visible-date cursor-date)))
  1352.  
  1353. (defvar calendar-debug-sexp nil
  1354.   "*Turn debugging on when evaluating a sexp in the diary or holiday list.")
  1355.  
  1356. (defvar calendar-mode-map nil)
  1357. (if calendar-mode-map
  1358.     nil
  1359.   (setq calendar-mode-map (make-sparse-keymap))
  1360.   (calendar-for-loop i from 0 to 9 do
  1361.        (define-key calendar-mode-map (int-to-string i) 'digit-argument))
  1362.   (let ((l (list 'narrow-to-region 'mark-word 'mark-sexp 'mark-paragraph
  1363.                  'mark-defun 'mark-whole-buffer 'mark-page 'kill-region
  1364.                  'copy-region-as-kill 'downcase-region 'upcase-region
  1365.                  'capitalize-region 'write-region)))
  1366.     (while (car l)
  1367.       (let ((k (where-is-internal (car l))))
  1368.         (while (car k)
  1369.           (define-key calendar-mode-map (car k) 'calendar-not-implemented)
  1370.           (setq k (cdr k)))
  1371.         (setq l (cdr l)))))
  1372.   (define-key calendar-mode-map "-"     'negative-argument)
  1373.   (define-key calendar-mode-map "\C-x>" 'scroll-calendar-right)
  1374.   (define-key calendar-mode-map "\ev"   'scroll-calendar-right-three-months)
  1375.   (define-key calendar-mode-map "\C-x<" 'scroll-calendar-left)
  1376.   (define-key calendar-mode-map "\C-v"  'scroll-calendar-left-three-months)
  1377.   (define-key calendar-mode-map "\C-b"  'calendar-backward-day)
  1378.   (define-key calendar-mode-map "\C-p"  'calendar-backward-week)
  1379.   (define-key calendar-mode-map "\e{"   'calendar-backward-month)
  1380.   (define-key calendar-mode-map "\C-x[" 'calendar-backward-year)
  1381.   (define-key calendar-mode-map "\C-f"  'calendar-forward-day)
  1382.   (define-key calendar-mode-map "\C-n"  'calendar-forward-week)
  1383.   (define-key calendar-mode-map [left]  'calendar-backward-day)
  1384.   (define-key calendar-mode-map [up]    'calendar-backward-week)
  1385.   (define-key calendar-mode-map [right] 'calendar-forward-day)
  1386.   (define-key calendar-mode-map [down]  'calendar-forward-week)
  1387.   (define-key calendar-mode-map "\e}"   'calendar-forward-month)
  1388.   (define-key calendar-mode-map "\C-x]" 'calendar-forward-year)
  1389.   (define-key calendar-mode-map "\C-a"  'calendar-beginning-of-week)
  1390.   (define-key calendar-mode-map "\C-e"  'calendar-end-of-week)
  1391.   (define-key calendar-mode-map "\ea"   'calendar-beginning-of-month)
  1392.   (define-key calendar-mode-map "\ee"   'calendar-end-of-month)
  1393.   (define-key calendar-mode-map "\e<"   'calendar-beginning-of-year)
  1394.   (define-key calendar-mode-map "\e>"   'calendar-end-of-year)
  1395.   (define-key calendar-mode-map "\C-@"  'calendar-set-mark)
  1396.   (define-key calendar-mode-map "\C-x\C-x" 'calendar-exchange-point-and-mark)
  1397.   (define-key calendar-mode-map "\e=" 'calendar-count-days-region)
  1398.   (define-key calendar-mode-map "gd"  'calendar-goto-date)
  1399.   (define-key calendar-mode-map "gj"  'calendar-goto-julian-date)
  1400.   (define-key calendar-mode-map "ga"  'calendar-goto-astro-day-number)
  1401.   (define-key calendar-mode-map "gh"  'calendar-goto-hebrew-date)
  1402.   (define-key calendar-mode-map "gi"  'calendar-goto-islamic-date)
  1403.   (define-key calendar-mode-map "gc"  'calendar-goto-iso-date)
  1404.   (define-key calendar-mode-map "gf"  'calendar-goto-french-date)
  1405.   (define-key calendar-mode-map "gml"  'calendar-goto-mayan-long-count-date)
  1406.   (define-key calendar-mode-map "gmpc" 'calendar-previous-calendar-round-date)
  1407.   (define-key calendar-mode-map "gmnc" 'calendar-next-calendar-round-date)
  1408.   (define-key calendar-mode-map "gmph" 'calendar-previous-haab-date)
  1409.   (define-key calendar-mode-map "gmnh" 'calendar-next-haab-date)
  1410.   (define-key calendar-mode-map "gmpt" 'calendar-previous-tzolkin-date)
  1411.   (define-key calendar-mode-map "gmnt" 'calendar-next-tzolkin-date)
  1412.   (define-key calendar-mode-map "S"   'calendar-sunrise-sunset)
  1413.   (define-key calendar-mode-map "M"   'calendar-phases-of-moon)
  1414.   (define-key calendar-mode-map " "   'scroll-other-window)
  1415.   (define-key calendar-mode-map "\C-c\C-l" 'redraw-calendar)
  1416.   (define-key calendar-mode-map "."   'calendar-current-month)
  1417.   (define-key calendar-mode-map "o"   'calendar-other-month)
  1418.   (define-key calendar-mode-map "q"   'exit-calendar)
  1419.   (define-key calendar-mode-map "a"   'list-calendar-holidays)
  1420.   (define-key calendar-mode-map "h"   'calendar-cursor-holidays)
  1421.   (define-key calendar-mode-map "x"   'mark-calendar-holidays)
  1422.   (define-key calendar-mode-map "u"   'calendar-unmark)
  1423.   (define-key calendar-mode-map "m"   'mark-diary-entries)
  1424.   (define-key calendar-mode-map "d"   'view-diary-entries)
  1425.   (define-key calendar-mode-map "s"   'show-all-diary-entries)
  1426.   (define-key calendar-mode-map "pd"  'calendar-print-day-of-year)
  1427.   (define-key calendar-mode-map "pc"  'calendar-print-iso-date)
  1428.   (define-key calendar-mode-map "pj"  'calendar-print-julian-date)
  1429.   (define-key calendar-mode-map "pa"  'calendar-print-astro-day-number)
  1430.   (define-key calendar-mode-map "ph"  'calendar-print-hebrew-date)
  1431.   (define-key calendar-mode-map "pi"  'calendar-print-islamic-date)
  1432.   (define-key calendar-mode-map "pf"  'calendar-print-french-date)
  1433.   (define-key calendar-mode-map "pm"  'calendar-print-mayan-date)
  1434.   (define-key calendar-mode-map "id"  'insert-diary-entry)
  1435.   (define-key calendar-mode-map "iw"  'insert-weekly-diary-entry)
  1436.   (define-key calendar-mode-map "im"  'insert-monthly-diary-entry)
  1437.   (define-key calendar-mode-map "iy"  'insert-yearly-diary-entry)
  1438.   (define-key calendar-mode-map "ia"  'insert-anniversary-diary-entry)
  1439.   (define-key calendar-mode-map "ib"  'insert-block-diary-entry)
  1440.   (define-key calendar-mode-map "ic"  'insert-cyclic-diary-entry)
  1441.   (define-key calendar-mode-map "ihd" 'insert-hebrew-diary-entry)
  1442.   (define-key calendar-mode-map "ihm" 'insert-monthly-hebrew-diary-entry)
  1443.   (define-key calendar-mode-map "ihy" 'insert-yearly-hebrew-diary-entry)
  1444.   (define-key calendar-mode-map "iid" 'insert-islamic-diary-entry)
  1445.   (define-key calendar-mode-map "iim" 'insert-monthly-islamic-diary-entry)
  1446.   (define-key calendar-mode-map "iiy" 'insert-yearly-islamic-diary-entry)
  1447.   (define-key calendar-mode-map "?"   'describe-calendar-mode))
  1448.  
  1449. (defun describe-calendar-mode ()
  1450.   "Create a help buffer with a brief description of the calendar-mode."
  1451.   (interactive)
  1452.   (with-output-to-temp-buffer "*Help*"
  1453.     (princ
  1454.      (format
  1455.       "Calendar Mode:\nFor a complete description, type %s\n%s\n"
  1456.       (substitute-command-keys
  1457.        "\\<calendar-mode-map>\\[describe-mode] from within the calendar")
  1458.       (substitute-command-keys "\\{calendar-mode-map}")))
  1459.     (print-help-return-message)))
  1460.  
  1461. ;; Calendar mode is suitable only for specially formatted data.
  1462. (put 'calendar-mode 'mode-class 'special)
  1463.  
  1464. (defvar calendar-mode-line-format
  1465.   (list
  1466.    (substitute-command-keys "\\<calendar-mode-map>\\[scroll-calendar-left]")
  1467.    "Calendar"
  1468.    (substitute-command-keys "\\<calendar-mode-map>\\[describe-calendar-mode] help/\\[calendar-other-month] other/\\[calendar-current-month] current")
  1469.    '(calendar-date-string (calendar-current-date) t)
  1470.    (substitute-command-keys "\\<calendar-mode-map>\\[scroll-calendar-right]"))
  1471.   "The mode line of the calendar buffer.")
  1472.  
  1473. (defun calendar-mode ()
  1474.   "A major mode for the calendar window.
  1475.  
  1476. The commands for cursor movement are:\\<calendar-mode-map>
  1477.  
  1478.        \\[calendar-forward-day]  one day forward           \\[calendar-backward-day]  one day backward
  1479.        \\[calendar-forward-week]  one week forward          \\[calendar-backward-week]  one week backward
  1480.        \\[calendar-forward-month]  one month forward       \\[calendar-backward-month]  one month backward
  1481.        \\[calendar-forward-year]  one year forward        \\[calendar-backward-year]  one year backward
  1482.        \\[calendar-beginning-of-week]  beginning of week         \\[calendar-end-of-week]  end of week
  1483.        \\[calendar-beginning-of-month]  beginning of month      \\[calendar-end-of-month]  end of month
  1484.        \\[calendar-beginning-of-year]  beginning of year       \\[calendar-end-of-year]  end of year
  1485.  
  1486.        \\[calendar-goto-date]  go to date
  1487.  
  1488.        \\[calendar-goto-julian-date]  go to Julian date         \\[calendar-goto-astro-day-number]  go to astronomical (Julian) day number
  1489.        \\[calendar-goto-hebrew-date]  go to Hebrew date         \\[calendar-goto-islamic-date]  go to Islamic date
  1490.        \\[calendar-goto-iso-date]  go to ISO date            \\[calendar-goto-french-date]  go to French Revolutionary date
  1491.  
  1492.        \\[calendar-goto-mayan-long-count-date]  go to Mayan Long Count date
  1493.        \\[calendar-next-haab-date]  go to next occurrence of Mayan Haab date
  1494.        \\[calendar-previous-haab-date]  go to previous occurrence of Mayan Haab date
  1495.        \\[calendar-next-tzolkin-date]  go to next occurrence of Mayan Tzolkin date
  1496.        \\[calendar-previous-tzolkin-date]  go to previous occurrence of Mayan Tzolkin date
  1497.        \\[calendar-next-calendar-round-date]  go to next occurrence of Mayan Calendar Round date
  1498.        \\[calendar-previous-calendar-round-date]  go to previous occurrence of Mayan Calendar Round date
  1499.  
  1500. You can mark a date in the calendar and switch the point and mark:
  1501.  
  1502.        \\[calendar-set-mark]  mark date                 \\[calendar-exchange-point-and-mark]  exchange point and mark
  1503.  
  1504. You can determine the number of days (inclusive) between the point and mark by
  1505.  
  1506.        \\[calendar-count-days-region]  count days in the region
  1507.  
  1508. The commands for calendar movement are:
  1509.  
  1510.        \\[scroll-calendar-right]  scroll one month right   \\[scroll-calendar-left]  scroll one month left
  1511.        \\[scroll-calendar-right-three-months]  scroll 3 months right    \\[scroll-calendar-left-three-months]  scroll 3 months left
  1512.        \\[calendar-current-month]  display current month        \\[calendar-other-month]  display another month
  1513.  
  1514. Whenever it makes sense, the above commands take prefix arguments that
  1515. multiply their affect.  For convenience, the digit keys and the minus sign
  1516. are bound to digit-argument, so they need not be prefixed with ESC.
  1517.  
  1518. If the calendar window somehow becomes corrupted, it can be regenerated with
  1519.  
  1520.        \\[redraw-calendar]  redraw the calendar
  1521.  
  1522. The following commands deal with holidays and other notable days:
  1523.  
  1524.        \\[calendar-cursor-holidays]  give holidays for the date specified by the cursor
  1525.        \\[mark-calendar-holidays]  mark notable days
  1526.        \\[calendar-unmark]  unmark dates
  1527.        \\[list-calendar-holidays]  display notable days
  1528.  
  1529. The command M-x holidays causes the notable dates for the current month, and
  1530. the preceding and succeeding months, to be displayed, independently of the
  1531. calendar.
  1532.  
  1533. The following commands control the diary:
  1534.  
  1535.        \\[mark-diary-entries]  mark diary entries          \\[calendar-unmark]  unmark dates
  1536.        \\[view-diary-entries]  display diary entries       \\[show-all-diary-entries]  show all diary entries
  1537.        \\[print-diary-entries]  print diary entries
  1538.  
  1539. Displaying the diary entries causes the diary entries from the diary-file
  1540. \(for the date indicated by the cursor in the calendar window) to be
  1541. displayed in another window.  This function takes an integer argument that
  1542. specifies the number of days of calendar entries to be displayed, starting
  1543. with the date indicated by the cursor.
  1544.  
  1545. The command \\[print-diary-entries] prints the diary buffer (as it appears)
  1546. on the line printer.
  1547.  
  1548. The command M-x diary causes the diary entries for the current date to be
  1549. displayed, independently of the calendar.  The number of days of entries is
  1550. governed by number-of-diary-entries.
  1551.  
  1552. The format of the entries in the diary file is described in the
  1553. documentation string for the variable diary-file.
  1554.  
  1555. When diary entries are in view in the window, they can be edited.  It is
  1556. important to keep in mind that the buffer displayed contains the entire
  1557. diary file, but with portions of it concealed from view.  This means, for
  1558. instance, that the forward-char command can put the cursor at what appears
  1559. to be the end of the line, but what is in reality the middle of some
  1560. concealed line.  BE CAREFUL WHEN EDITING THE DIARY ENTRIES! (Inserting
  1561. additional lines or adding/deleting characters in the middle of a visible
  1562. line will not cause problems; watch out for end-of-line, however--it may
  1563. put you at the end of a concealed line far from where the cursor appears to
  1564. be!)  BEFORE EDITING THE DIARY IT IS BEST TO DISPLAY THE ENTIRE FILE WITH
  1565. show-all-diary-entries.  BE SURE TO WRITE THE FILE BEFORE EXITING FROM THE
  1566. CALENDAR.
  1567.  
  1568. The following commands assist in making diary entries:
  1569.  
  1570.        \\[insert-diary-entry]  insert a diary entry for the selected date
  1571.        \\[insert-weekly-diary-entry]  insert a diary entry for the selected day of the week
  1572.        \\[insert-monthly-diary-entry]  insert a diary entry for the selected day of the month
  1573.        \\[insert-yearly-diary-entry]  insert a diary entry for the selected day of the year
  1574.        \\[insert-block-diary-entry]  insert a diary entry for the block days between point and mark
  1575.        \\[insert-anniversary-diary-entry]  insert an anniversary diary entry for the selected date
  1576.        \\[insert-cyclic-diary-entry]  insert a cyclic diary entry
  1577.  
  1578. There are corresponding commands to assist in making Hebrew- or Islamic-date
  1579. diary entries:
  1580.  
  1581.        \\[insert-hebrew-diary-entry]  insert a diary entry for the Hebrew date corresponding
  1582.                 to the selected date
  1583.        \\[insert-monthly-hebrew-diary-entry]  insert a diary entry for the day of the Hebrew month
  1584.                 corresponding to the selected day
  1585.        \\[insert-yearly-hebrew-diary-entry]  insert a diary entry for the day of the Hebrew year
  1586.                 corresponding to the selected day
  1587.        \\[insert-islamic-diary-entry]  insert a diary entry for the Islamic date corresponding
  1588.                 to the selected date
  1589.        \\[insert-monthly-islamic-diary-entry]  insert a diary entry for the day of the Islamic month
  1590.                 corresponding to the selected day
  1591.        \\[insert-yearly-islamic-diary-entry]  insert a diary entry for the day of the Islamic year
  1592.                 corresponding to the selected day
  1593.  
  1594. All of the diary entry commands make nonmarking entries when given a prefix
  1595. argument; with no prefix argument, the diary entries are marking.
  1596.  
  1597. The day number in the year and the number of days remaining in the year can be
  1598. determined by
  1599.  
  1600.        \\[calendar-print-day-of-year]  show day number and the number of days remaining in the year
  1601.  
  1602. Equivalent dates on the ISO commercial, Julian, Hebrew, Islamic, French
  1603. Revolutionary, and Mayan calendars can be determined by
  1604.  
  1605.        \\[calendar-print-iso-date]  show equivalent date on the ISO commercial calendar
  1606.        \\[calendar-print-julian-date]  show equivalent date on the Julian calendar
  1607.        \\[calendar-print-hebrew-date]  show equivalent date on the Hebrew calendar
  1608.        \\[calendar-print-islamic-date]  show equivalent date on the Islamic calendar
  1609.        \\[calendar-print-french-date]  show equivalent date on the French Revolutionary calendar
  1610.        \\[calendar-print-mayan-date]  show equivalent date on the Mayan calendar
  1611.  
  1612. The astronomical (Julian) day number of a date is found with
  1613.  
  1614.        \\[calendar-print-astro-day-number]  show equivalent astronomical (Julian) day number
  1615.  
  1616. To find the times of sunrise and sunset and lunar phases use
  1617.  
  1618.        \\[calendar-sunrise-sunset]  show times of sunrise and sunset
  1619.        \\[calendar-phases-of-moon]  show times of quarters of the moon
  1620.  
  1621. The times given will be at latitude `solar-latitude', longitude
  1622. `solar-longitude' in time zone `solar-time-zone'.  These variables, and the
  1623. variables `solar-location-name', `solar-standard-time-zone-name',
  1624. `solar-daylight-time-zone-name', `solar-daylight-savings-starts',
  1625. `solar-daylight-savings-ends', `calendar-daylight-time-offset',
  1626. and `calendar-daylight-savings-switchover-time' should be set for
  1627. your location.
  1628.  
  1629. To exit from the calendar use
  1630.  
  1631.        \\[exit-calendar]  exit from calendar
  1632.  
  1633. The variable `view-diary-entries-initially', whose default is nil, can be
  1634. set to to t cause diary entries for the current date will be displayed in
  1635. another window when the calendar is first displayed, if the current date is
  1636. visible.  The variable `number-of-diary-entries' controls number of days of
  1637. diary entries that will be displayed initially or with the command M-x
  1638. diary.  For example, if the default value 1 is used, then only the current
  1639. day's diary entries will be displayed.  If the value 2 is used, both the
  1640. current day's and the next day's entries will be displayed.  The value can
  1641. also be a vector: If the value is [0 2 2 2 2 4 1] then no diary entries
  1642. will be displayed on Sunday, the current date's and the next day's diary
  1643. entries will be displayed Monday through Thursday, Friday through Monday's
  1644. entries will be displayed on Friday, while on Saturday only that day's
  1645. entries will be displayed.
  1646.  
  1647. The variable `view-calendar-holidays-initially' can be set to t to cause the
  1648. holidays for the current three month period will be displayed on entry to the
  1649. calendar.  The holidays are displayed in another window.
  1650.  
  1651. The variable `mark-diary-entries-in-calendar' can be set to t to cause any
  1652. dates visible with calendar entries to be marked with the symbol specified by
  1653. the variable `diary-entry-marker', normally a plus sign.
  1654.  
  1655. The variable `calendar-load-hook', whose default value is nil, is list of
  1656. functions to be called when the calendar is first loaded.
  1657.  
  1658. The variable `initial-calendar-window-hook', whose default value is nil, is
  1659. list of functions to be called when the calendar window is first opened.  The
  1660. functions invoked are called after the calendar window is opened, but once
  1661. opened is never called again.  Leaving the calendar with the `q' command and
  1662. reentering it will cause these functions to be called again.
  1663.  
  1664. The variable `today-visible-calendar-hook', whose default value is nil, is the
  1665. list of functions called after the calendar buffer has been prepared with the
  1666. calendar when the current date is visible in the window.  This can be used,
  1667. for example, to replace today's date with asterisks; a function
  1668. calendar-star-date is included for this purpose: (setq
  1669. today-visible-calendar-hook 'calendar-star-date) It could also be used to mark
  1670. the current date with `*'; a function is also provided for this: (setq
  1671. today-visible-calendar-hook 'calendar-mark-today)
  1672.  
  1673. The variable `today-invisible-calendar-hook', whose default value is nil, is
  1674. the list of functions called after the calendar buffer has been prepared with
  1675. the calendar when the current date is not visible in the window.
  1676.  
  1677. The variable `diary-display-hook' is the list of functions called after the
  1678. diary buffer is prepared.  The default value simply displays the diary file
  1679. using selective-display to conceal irrelevant diary entries.  An alternative
  1680. function `fancy-diary-display' is provided that, when used as the
  1681. `diary-display-hook', causes a noneditable buffer to be prepared with a neatly
  1682. organized day-by-day listing of relevant diary entries, together with any
  1683. known holidays.  The inclusion of the holidays slows this fancy display of the
  1684. diary; to speed it up, set the variable `holidays-in-diary-buffer' to nil.
  1685.  
  1686. The variable `print-diary-entries-hook' is the list of functions called after
  1687. a temporary buffer is prepared with the diary entries currently visible in the
  1688. diary buffer.  The default value of this hook adds a heading (composed from
  1689. the diary buffer's mode line), does the printing with the command lpr-buffer,
  1690. and kills the temporary buffer.  Other uses might include, for example,
  1691. rearranging the lines into order by day and time.
  1692.  
  1693. The Gregorian calendar is assumed."
  1694.  
  1695.   (kill-all-local-variables)
  1696.   (setq major-mode 'calendar-mode)
  1697.   (setq mode-name "Calendar")
  1698.   (use-local-map calendar-mode-map)
  1699.   (setq buffer-read-only t)
  1700.   (setq indent-tabs-mode nil)
  1701.   (update-calendar-mode-line)
  1702.   (make-local-variable 'calendar-window-configuration);; Windows on entry.
  1703.   (make-local-variable 'calendar-mark-ring)
  1704.   (make-local-variable 'displayed-month);;  Month in middle of window.
  1705.   (make-local-variable 'displayed-year));;  Year in middle of window.
  1706.  
  1707. (defun calendar-string-spread (strings char length)
  1708.   "Concatenate list of STRINGS separated with copies of CHAR to fill LENGTH
  1709. There must be at least 2 strings.  The effect is like mapconcat but the
  1710. separating pieces are as balanced as possible.  Each item of STRINGS is
  1711. evaluated before concatenation so it can actually be an expression that
  1712. evaluates to a string.  If LENGTH is too short, the STRINGS are just
  1713. concatenated and the result truncated."
  1714. ;; The algorithm is based on equation (3.25) on page 85 of Concrete
  1715. ;; Mathematics by Ronald L. Graham, Donald E. Knuth, and Oren Patashnik,
  1716. ;; Addison-Wesley, Reading, MA, 1989
  1717.   (let* ((strings (mapcar 'eval strings))
  1718.          (n (- length (length (apply 'concat strings))))
  1719.          (m (1- (length strings)))
  1720.          (s (car strings))
  1721.          (strings (cdr strings))
  1722.          (i 0))
  1723.     (while strings
  1724.       (setq s (concat s
  1725.                       (make-string (max 0 (/ (+ n i) m)) char)
  1726.                       (car strings)))
  1727.       (setq i (1+ i))
  1728.       (setq strings (cdr strings)))
  1729.     (substring s 0 length)))
  1730.  
  1731. (defun update-calendar-mode-line ()
  1732.   "Update the calendar mode line with the current date and date style."
  1733.   (if (bufferp (get-buffer calendar-buffer))
  1734.       (save-excursion
  1735.         (set-buffer calendar-buffer)
  1736.         (setq mode-line-format
  1737.               (calendar-string-spread
  1738.                calendar-mode-line-format ?  (frame-width))))))
  1739.  
  1740. (defun exit-calendar ()
  1741.   "Get out of the calendar window and bury it and related buffers."
  1742.   (interactive)
  1743.   (let ((diary-buffer (get-file-buffer diary-file))
  1744.         (d-buffer (get-buffer fancy-diary-buffer))
  1745.         (h-buffer (get-buffer holiday-buffer)))
  1746.     (if (not diary-buffer)
  1747.         (progn
  1748.           (set-window-configuration calendar-window-configuration)
  1749.           (bury-buffer calendar-buffer)
  1750.           (if d-buffer (bury-buffer d-buffer))
  1751.           (if h-buffer (bury-buffer h-buffer)))
  1752.       (if (or (not (buffer-modified-p diary-buffer))
  1753.               (yes-or-no-p "Diary modified; do you really want to exit the calendar? "))
  1754.           (progn
  1755.             (set-window-configuration calendar-window-configuration)
  1756.             (bury-buffer calendar-buffer)
  1757.             (if d-buffer (bury-buffer d-buffer))
  1758.             (if h-buffer (bury-buffer h-buffer))
  1759.             (set-buffer diary-buffer)
  1760.             (set-buffer-modified-p nil)
  1761.             (bury-buffer diary-buffer))))))
  1762.  
  1763. (defun calendar-current-month ()
  1764.   "Reposition the calendar window so the current date is visible."
  1765.   (interactive)
  1766.   (let ((today (calendar-current-date)));; The date might have changed.
  1767.     (if (not (calendar-date-is-visible-p today))
  1768.         (generate-calendar-window)
  1769.       (update-calendar-mode-line)
  1770.       (calendar-cursor-to-visible-date today))))
  1771.  
  1772. (defun calendar-forward-month (arg)
  1773.   "Move the cursor forward ARG months.
  1774. Movement is backward if ARG is negative."
  1775.   (interactive "p")
  1776.   (calendar-cursor-to-nearest-date)
  1777.   (let* ((cursor-date (or (calendar-cursor-to-date)
  1778.                           (error "Cursor is not on a date!")))
  1779.          (month (extract-calendar-month cursor-date))
  1780.          (day (extract-calendar-day cursor-date))
  1781.          (year (extract-calendar-year cursor-date)))
  1782.     (increment-calendar-month month year arg)
  1783.     (let ((last (calendar-last-day-of-month month year)))
  1784.       (if (< last day)
  1785.         (setq day last)))
  1786.     ;; Put the new month on the screen, if needed, and go to the new date.
  1787.     (let ((new-cursor-date (list month day year)))
  1788.       (if (not (calendar-date-is-visible-p new-cursor-date))
  1789.           (calendar-other-month month year))
  1790.       (calendar-cursor-to-visible-date new-cursor-date))))
  1791.  
  1792. (defun calendar-forward-year (arg)
  1793.   "Move the cursor forward by ARG years.
  1794. Movement is backward if ARG is negative."
  1795.   (interactive "p")
  1796.   (calendar-forward-month (* 12 arg)))
  1797.  
  1798. (defun calendar-backward-month (arg)
  1799.   "Move the cursor backward by ARG months.
  1800. Movement is forward if ARG is negative."
  1801.   (interactive "p")
  1802.   (calendar-forward-month (- arg)))
  1803.  
  1804. (defun calendar-backward-year (arg)
  1805.   "Move the cursor backward ARG years.
  1806. Movement is forward is ARG is negative."
  1807.   (interactive "p")
  1808.   (calendar-forward-month (* -12 arg)))
  1809.  
  1810. (defun scroll-calendar-left (arg)
  1811.   "Scroll the displayed calendar left by ARG months.
  1812. If ARG is negative the calendar is scrolled right.  Maintains the relative
  1813. position of the cursor with respect to the calendar as well as possible."
  1814.   (interactive "p")
  1815.   (calendar-cursor-to-nearest-date)
  1816.   (let ((old-date (calendar-cursor-to-date))
  1817.         (today (calendar-current-date)))
  1818.     (if (/= arg 0)
  1819.         (progn
  1820.           (increment-calendar-month displayed-month displayed-year arg)
  1821.           (generate-calendar-window displayed-month displayed-year)
  1822.           (calendar-cursor-to-visible-date
  1823.            (cond
  1824.             ((calendar-date-is-visible-p old-date) old-date)
  1825.             ((calendar-date-is-visible-p today) today)
  1826.             (t (list displayed-month 1 displayed-year))))))))
  1827.  
  1828. (defun scroll-calendar-right (arg)
  1829.   "Scroll the displayed calendar window right by ARG months.
  1830. If ARG is negative the calendar is scrolled left.  Maintains the relative
  1831. position of the cursor with respect to the calendar as well as possible."
  1832.   (interactive "p")
  1833.   (scroll-calendar-left (- arg)))
  1834.  
  1835. (defun scroll-calendar-left-three-months (arg)
  1836.   "Scroll the displayed calendar window left by 3*ARG months.
  1837. If ARG is negative the calendar is scrolled right.  Maintains the relative
  1838. position of the cursor with respect to the calendar as well as possible."
  1839.   (interactive "p")
  1840.   (scroll-calendar-left (* 3 arg)))
  1841.  
  1842. (defun scroll-calendar-right-three-months (arg)
  1843.   "Scroll the displayed calendar window right by 3*ARG months.
  1844. If ARG is negative the calendar is scrolled left.  Maintains the relative
  1845. position of the cursor with respect to the calendar as well as possible."
  1846.   (interactive "p")
  1847.   (scroll-calendar-left (* -3 arg)))
  1848.  
  1849. (defun calendar-current-date ()
  1850.   "Returns the current date in a list (month day year).
  1851. If in the calendar buffer, also sets the current date local variables."
  1852.   (let* ((date (current-time-string))
  1853.          (garbage
  1854.           (string-match
  1855.            "^\\([A-Z][a-z]*\\) *\\([A-Z][a-z]*\\) *\\([0-9]*\\) .* \\([0-9]*\\)$"
  1856.            date))
  1857.          (month
  1858.           (cdr (assoc 
  1859.                 (substring date (match-beginning 2) (match-end 2))
  1860.                 (calendar-make-alist
  1861.                  calendar-month-name-array
  1862.                  1
  1863.                  '(lambda (x) (substring x 0 3))))))
  1864.          (day
  1865.           (string-to-int (substring date (match-beginning 3) (match-end 3))))
  1866.          (year
  1867.           (string-to-int (substring date (match-beginning 4) (match-end 4)))))
  1868.     (list month day year)))
  1869.  
  1870. (defun calendar-cursor-to-date ()
  1871.   "Returns a list of the month, day, and year of current cursor position.
  1872. Returns nil if the cursor is not on a specific day."
  1873.   (if (and (looking-at "[*0-9]")
  1874.            (< 2 (count-lines (point-min) (point))))
  1875.       (save-excursion
  1876.         (re-search-backward "[^0-9]")
  1877.         (forward-char 1)
  1878.         (let*
  1879.             ((day (string-to-int (buffer-substring (point) (+ 3 (point)))))
  1880.              (day (if (= 0 day) starred-day day))
  1881.              (segment (/ (current-column) 25))
  1882.              (month (% (+ displayed-month segment -1) 12))
  1883.              (month (if (= 0 month) 12 month))
  1884.              (year
  1885.               (cond
  1886.                ((and (=  12 month) (= segment 0)) (1- displayed-year))
  1887.                ((and (=   1 month) (= segment 2)) (1+ displayed-year))
  1888.                (t displayed-year))))
  1889.           (list month day year)))))
  1890.  
  1891. (defun calendar-cursor-to-nearest-date ()
  1892.   "Move the cursor to the closest date.
  1893. The position of the cursor is unchanged if it is already on a date.
  1894. Returns the list (month day year) giving the cursor position."
  1895.   (let ((date (calendar-cursor-to-date))
  1896.         (column (current-column)))
  1897.     (if date
  1898.         date
  1899.       (if (> 3 (count-lines (point-min) (point)))
  1900.           (progn
  1901.             (goto-line 3)
  1902.             (move-to-column column)))
  1903.       (if (not (looking-at "[0-9]"))
  1904.           (if (and (not (looking-at " *$"))
  1905.                    (or (< column 25)
  1906.                        (and (> column 27)
  1907.                             (< column 50))
  1908.                        (and (> column 52)
  1909.                             (< column 75))))
  1910.               (progn
  1911.                 (re-search-forward "[0-9]" nil t)
  1912.                 (backward-char 1))
  1913.             (re-search-backward "[0-9]" nil t)))
  1914.       (calendar-cursor-to-date))))
  1915.  
  1916. (defun calendar-forward-day (arg)
  1917.   "Move the cursor forward ARG days.
  1918. Moves backward if ARG is negative."
  1919.   (interactive "p")
  1920.   (if (/= 0 arg)
  1921.       (let*
  1922.           ((cursor-date (calendar-cursor-to-date))
  1923.            (cursor-date (if cursor-date
  1924.                             cursor-date
  1925.                           (if (> arg 0) (setq arg (1- arg)))
  1926.                           (calendar-cursor-to-nearest-date)))
  1927.            (new-cursor-date
  1928.             (calendar-gregorian-from-absolute
  1929.              (+ (calendar-absolute-from-gregorian cursor-date) arg)))
  1930.            (new-display-month (extract-calendar-month new-cursor-date))
  1931.            (new-display-year (extract-calendar-year new-cursor-date)))
  1932.         ;; Put the new month on the screen, if needed, and go to the new date.
  1933.         (if (not (calendar-date-is-visible-p new-cursor-date))
  1934.             (calendar-other-month new-display-month new-display-year))
  1935.         (calendar-cursor-to-visible-date new-cursor-date))))
  1936.  
  1937. (defun calendar-backward-day (arg)
  1938.   "Move the cursor back ARG days.
  1939. Moves forward if ARG is negative."
  1940.   (interactive "p")
  1941.   (calendar-forward-day (- arg)))
  1942.  
  1943. (defun calendar-forward-week (arg)
  1944.   "Move the cursor forward ARG weeks.
  1945. Moves backward if ARG is negative."
  1946.   (interactive "p")
  1947.   (calendar-forward-day (* arg 7)))
  1948.  
  1949. (defun calendar-backward-week (arg)
  1950.   "Move the cursor back ARG weeks.
  1951. Moves forward if ARG is negative."
  1952.   (interactive "p")
  1953.   (calendar-forward-day (* arg -7)))
  1954.  
  1955. (defun calendar-beginning-of-week (arg)
  1956.   "Move the cursor back ARG Sundays."
  1957.   (interactive "p")
  1958.   (calendar-cursor-to-nearest-date)
  1959.   (let ((day (calendar-day-of-week (calendar-cursor-to-date))))
  1960.     (calendar-backward-day
  1961.      (if (= day 0) (* 7 arg) (+ day (* 7 (1- arg)))))))
  1962.  
  1963. (defun calendar-end-of-week (arg)
  1964.   "Move the cursor forward ARG Saturdays."
  1965.   (interactive "p")
  1966.   (calendar-cursor-to-nearest-date)
  1967.   (let ((day (calendar-day-of-week (calendar-cursor-to-date))))
  1968.     (calendar-forward-day
  1969.      (if (= day 6) (* 7 arg) (+ (- 6 day) (* 7 (1- arg)))))))
  1970.  
  1971. (defun calendar-beginning-of-month (arg)
  1972.   "Move the cursor backward ARG month beginnings."
  1973.   (interactive "p")
  1974.   (calendar-cursor-to-nearest-date)
  1975.   (let* ((date (calendar-cursor-to-date))
  1976.          (month (extract-calendar-month date))
  1977.          (day (extract-calendar-day date))
  1978.          (year (extract-calendar-year date)))
  1979.     (if (= day 1)
  1980.         (calendar-backward-month arg)
  1981.       (calendar-cursor-to-visible-date (list month 1 year))
  1982.       (calendar-backward-month (1- arg)))))
  1983.  
  1984. (defun calendar-end-of-month (arg)
  1985.   "Move the cursor forward ARG month ends."
  1986.   (interactive "p")
  1987.   (calendar-cursor-to-nearest-date)
  1988.   (let* ((date (calendar-cursor-to-date))
  1989.          (month (extract-calendar-month date))
  1990.          (day (extract-calendar-day date))
  1991.          (year (extract-calendar-year date))
  1992.          (last-day (calendar-last-day-of-month month year)))
  1993.     (if (/= day last-day)
  1994.         (progn
  1995.           (calendar-cursor-to-visible-date (list month last-day year))
  1996.           (setq arg (1- arg))))
  1997.     (increment-calendar-month month year arg)
  1998.     (let ((last-day (list
  1999.                      month
  2000.                      (calendar-last-day-of-month month year)
  2001.                      year)))
  2002.       (if (not (calendar-date-is-visible-p last-day))
  2003.           (calendar-other-month month year)
  2004.       (calendar-cursor-to-visible-date last-day)))))
  2005.  
  2006. (defun calendar-beginning-of-year (arg)
  2007.   "Move the cursor backward ARG year beginnings."
  2008.   (interactive "p")
  2009.   (calendar-cursor-to-nearest-date)
  2010.   (let* ((date (calendar-cursor-to-date))
  2011.          (month (extract-calendar-month date))
  2012.          (day (extract-calendar-day date))
  2013.          (year (extract-calendar-year date))
  2014.          (jan-first (list 1 1 year)))
  2015.     (if (and (= day 1) (= 1 month))
  2016.         (calendar-backward-month (* 12 arg))
  2017.       (if (and (= arg 1)
  2018.                (calendar-date-is-visible-p jan-first))
  2019.           (calendar-cursor-to-visible-date jan-first)
  2020.         (calendar-other-month 1 (- year (1- arg)))))))
  2021.  
  2022. (defun calendar-end-of-year (arg)
  2023.   "Move the cursor forward ARG year beginnings."
  2024.   (interactive "p")
  2025.   (calendar-cursor-to-nearest-date)
  2026.   (let* ((date (calendar-cursor-to-date))
  2027.          (month (extract-calendar-month date))
  2028.          (day (extract-calendar-day date))
  2029.          (year (extract-calendar-year date))
  2030.          (dec-31 (list 12 31 year)))
  2031.     (if (and (= day 31) (= 12 month))
  2032.         (calendar-forward-month (* 12 arg))
  2033.       (if (and (= arg 1)
  2034.                (calendar-date-is-visible-p dec-31))
  2035.           (calendar-cursor-to-visible-date dec-31)
  2036.         (calendar-other-month 12 (- year (1- arg)))
  2037.         (calendar-cursor-to-visible-date (list 12 31 displayed-year))))))
  2038.  
  2039. ;; The following version of calendar-gregorian-from-absolute is preferred for
  2040. ;; reasons of clarity, BUT it's much slower than the version that follows it.
  2041.  
  2042. ;;(defun calendar-gregorian-from-absolute (date)
  2043. ;;  "Compute the list (month day year) corresponding to the absolute DATE.
  2044. ;;The absolute date is the number of days elapsed since the (imaginary)
  2045. ;;Gregorian date Sunday, December 31, 1 BC."
  2046. ;;  (let* ((approx (/ date 366));; Approximation from below.
  2047. ;;         (year                ;; Search forward from the approximation.
  2048. ;;          (+ approx
  2049. ;;             (calendar-sum y approx
  2050. ;;                 (>= date (calendar-absolute-from-gregorian (list 1 1 (1+ y))))
  2051. ;;                  1)))
  2052. ;;         (month         ;; Search forward from January.
  2053. ;;          (1+ (calendar-sum m 1
  2054. ;;                   (> date
  2055. ;;                      (calendar-absolute-from-gregorian
  2056. ;;                       (list m (calendar-last-day-of-month m year) year)))
  2057. ;;                   1)))
  2058. ;;         (day           ;; Calculate the day by subtraction.
  2059. ;;          (- date
  2060. ;;             (1- (calendar-absolute-from-gregorian (list month 1 year))))))
  2061. ;;    (list month day year)))
  2062.  
  2063. (defun calendar-gregorian-from-absolute (date)
  2064.   "Compute the list (month day year) corresponding to the absolute DATE.
  2065. The absolute date is the number of days elapsed since the (imaginary)
  2066. Gregorian date Sunday, December 31, 1 BC."
  2067. ;; See the footnote on page 384 of ``Calendrical Calculations, Part II:
  2068. ;; Three Historical Calendars'' by E. M. Reingold,  N. Dershowitz, and S. M.
  2069. ;; Clamen, Software--Practice and Experience, Volume 23, Number 4
  2070. ;; (April, 1993), pages 383-404 for an explanation.
  2071.   (let* ((d0 (1- date))
  2072.          (n400 (/ d0 146097))
  2073.          (d1 (% d0 146097))
  2074.          (n100 (/ d1 36524))
  2075.          (d2 (% d1 36524))
  2076.          (n4 (/ d2 1461))
  2077.          (d3 (% d2 1461))
  2078.          (n1 (/ d3 365))
  2079.          (day (1+ (% d3 365)))
  2080.          (year (+ (* 400 n400) (* 100 n100) (* n4 4) n1)))
  2081.     (if (or (= n100 4) (= n1 4))
  2082.         (list 12 31 year)
  2083.       (let ((year (1+ year))
  2084.             (month 1))
  2085.         (while (let ((mdays (calendar-last-day-of-month month year)))
  2086.                  (and (< mdays day)
  2087.                       (setq day (- day mdays))))
  2088.           (setq month (1+ month)))
  2089.         (list month day year)))))
  2090.  
  2091. (defun calendar-cursor-to-visible-date (date)
  2092.   "Move the cursor to DATE that is on the screen."
  2093.     (let ((month (extract-calendar-month date))
  2094.           (day (extract-calendar-day date))
  2095.           (year (extract-calendar-year date)))
  2096.       (goto-line (+ 3
  2097.                     (/ (+ day -1
  2098.                           (calendar-day-of-week (list month 1 year)))
  2099.                        7)))
  2100.       (move-to-column (+ 6
  2101.                          (* 25
  2102.                             (1+ (calendar-interval
  2103.                                  displayed-month displayed-year month year)))
  2104.                          (* 3 (calendar-day-of-week date))))))
  2105.  
  2106. (defun calendar-other-month (month year)
  2107.   "Display a three-month calendar centered around MONTH and YEAR."
  2108.   (interactive
  2109.    (let* ((completion-ignore-case t)
  2110.           (month (cdr (assoc
  2111.                        (capitalize
  2112.                         (completing-read
  2113.                          "Month name: "
  2114.                          (mapcar 'list (append calendar-month-name-array nil))
  2115.                          nil t))
  2116.                        (calendar-make-alist calendar-month-name-array))))
  2117.           (year (calendar-read
  2118.                  "Year (>0): "
  2119.                  '(lambda (x) (> x 0))
  2120.                  (int-to-string
  2121.                   (extract-calendar-year (calendar-current-date))))))
  2122.      (list month year)))
  2123.   (if (and (= month displayed-month)
  2124.            (= year displayed-year))
  2125.       nil
  2126.     (let ((old-date (calendar-cursor-to-date))
  2127.           (today (calendar-current-date)))
  2128.       (generate-calendar-window month year)
  2129.       (calendar-cursor-to-visible-date
  2130.        (cond
  2131.         ((calendar-date-is-visible-p old-date) old-date)
  2132.         ((calendar-date-is-visible-p today) today)
  2133.         (t (list month 1 year)))))))
  2134.  
  2135. (defun calendar-set-mark (arg)
  2136.   "Mark the date under the cursor, or jump to marked date.
  2137. With no prefix argument, push current date onto marked date ring.
  2138. With argument, jump to mark, pop it, and put point at end of ring."
  2139.   (interactive "P")
  2140.   (let ((date (or (calendar-cursor-to-date)
  2141.                   (error "Cursor is not on a date!"))))
  2142.     (if (null arg)
  2143.         (progn
  2144.           (setq calendar-mark-ring (cons date calendar-mark-ring))
  2145.           ;; Since the top of the mark ring is the marked date in the
  2146.           ;; calendar, the mark ring in the calendar is one longer than
  2147.           ;; in other buffers to get the same effect.
  2148.           (if (> (length calendar-mark-ring) (1+ mark-ring-max))
  2149.               (setcdr (nthcdr mark-ring-max calendar-mark-ring) nil))
  2150.           (message "Mark set"))
  2151.       (if (null calendar-mark-ring)
  2152.           (error "No mark set in this buffer")
  2153.         (calendar-goto-date (car calendar-mark-ring))
  2154.         (setq calendar-mark-ring
  2155.               (cdr (nconc calendar-mark-ring (list date))))))))
  2156.  
  2157. (defun calendar-exchange-point-and-mark ()
  2158.   "Exchange the current cursor position with the marked date."
  2159.   (interactive)
  2160.   (let ((mark (car calendar-mark-ring))
  2161.         (date (or (calendar-cursor-to-date)
  2162.                   (error "Cursor is not on a date!"))))
  2163.     (if (null mark)
  2164.         (error "No mark set in this buffer")
  2165.       (setq calendar-mark-ring (cons date (cdr calendar-mark-ring)))
  2166.       (calendar-goto-date mark))))
  2167.  
  2168. (defun calendar-count-days-region ()
  2169.   "Count the number of days (inclusive) between point and the mark."
  2170.   (interactive)
  2171.   (let* ((days (- (calendar-absolute-from-gregorian
  2172.                    (or (calendar-cursor-to-date)
  2173.                        (error "Cursor is not on a date!")))
  2174.                   (calendar-absolute-from-gregorian
  2175.                    (or (car calendar-mark-ring)
  2176.                        (error "No mark set in this buffer")))))
  2177.          (days (1+ (if (> days 0) days (- days)))))
  2178.     (message "Region has %d day%s (inclusive)"
  2179.              days (if (> days 1) "s" ""))))
  2180.  
  2181. (defun calendar-not-implemented ()
  2182.   "Not implemented."
  2183.   (interactive)
  2184.   (error "%s not available in the calendar"
  2185.          (global-key-binding (this-command-keys))))
  2186.  
  2187. (defun calendar-read (prompt acceptable &optional initial-contents)
  2188.   "Return an object read from the minibuffer.
  2189. Prompt with the string PROMPT and use the function ACCEPTABLE to decide if
  2190. entered item is acceptable.  If non-nil, optional third arg INITIAL-CONTENTS
  2191. is a string to insert in the minibuffer before reading."
  2192.   (let ((value (read-minibuffer prompt initial-contents)))
  2193.     (while (not (funcall acceptable value))
  2194.       (setq value (read-minibuffer prompt initial-contents)))
  2195.     value))
  2196.  
  2197. (defun calendar-read-date ()
  2198.   "Prompt for Gregorian date.  Returns a list (month day year)."
  2199.   (let* ((year (calendar-read
  2200.                 "Year (>0): "
  2201.                 '(lambda (x) (> x 0))
  2202.                 (int-to-string (extract-calendar-year
  2203.                                 (calendar-current-date)))))
  2204.          (month-array calendar-month-name-array)
  2205.          (completion-ignore-case t)
  2206.          (month (cdr (assoc
  2207.                       (capitalize
  2208.                        (completing-read
  2209.                         "Month name: "
  2210.                         (mapcar 'list (append month-array nil))
  2211.                         nil t))
  2212.                       (calendar-make-alist month-array 1 'capitalize))))
  2213.          (last (calendar-last-day-of-month month year))
  2214.          (day (calendar-read
  2215.                (format "Day (1-%d): " last)
  2216.                '(lambda (x) (and (< 0 x) (<= x last))))))
  2217.     (list month day year)))
  2218.  
  2219. (defun calendar-goto-date (date)
  2220.   "Move cursor to DATE."
  2221.   (interactive (list (calendar-read-date)))
  2222.   (let ((month (extract-calendar-month date))
  2223.         (year (extract-calendar-year date)))
  2224.     (if (not (calendar-date-is-visible-p date))
  2225.         (calendar-other-month
  2226.          (if (and (= month 1) (= year 1))
  2227.              2
  2228.            month)
  2229.          year)))
  2230.   (calendar-cursor-to-visible-date date))
  2231.  
  2232. (defun calendar-goto-julian-date (date &optional noecho)
  2233.   "Move cursor to Julian DATE; echo Julian date unless NOECHO is t."
  2234.   (interactive
  2235.    (let* ((today (calendar-current-date))
  2236.           (year (calendar-read
  2237.                  "Julian calendar year (>0): "
  2238.                  '(lambda (x) (> x 0))
  2239.                  (int-to-string
  2240.                   (extract-calendar-year
  2241.                    (calendar-julian-from-absolute
  2242.                     (calendar-absolute-from-gregorian
  2243.                      today))))))
  2244.           (month-array calendar-month-name-array)
  2245.           (completion-ignore-case t)
  2246.           (month (cdr (assoc
  2247.                        (capitalize
  2248.                         (completing-read
  2249.                          "Julian calendar month name: "
  2250.                          (mapcar 'list (append month-array nil))
  2251.                          nil t))
  2252.                        (calendar-make-alist month-array 1 'capitalize))))
  2253.           (last 
  2254.            (if (and (zerop (% year 4)) (= month 2))
  2255.                29
  2256.              (aref [31 28 31 30 31 30 31 31 30 31 30 31] (1- month))))
  2257.           (day (calendar-read
  2258.                 (format "Julian calendar day (%d-%d): "
  2259.                         (if (and (= year 1) (= month 1)) 3 1) last)
  2260.                 '(lambda (x) 
  2261.                    (and (< (if (and (= year 1) (= month 1)) 2 0) x)
  2262.                         (<= x last))))))
  2263.      (list (list month day year))))
  2264.   (calendar-goto-date (calendar-gregorian-from-absolute
  2265.                        (calendar-absolute-from-julian date)))
  2266.   (or noecho (calendar-print-julian-date)))
  2267.  
  2268. (defun calendar-goto-hebrew-date (date &optional noecho)
  2269.   "Move cursor to Hebrew DATE; echo Hebrew date unless NOECHO is t."
  2270.   (interactive
  2271.    (let* ((today (calendar-current-date))
  2272.           (year (calendar-read
  2273.                  "Hebrew calendar year (>3760): "
  2274.                  '(lambda (x) (> x 3760))
  2275.                  (int-to-string
  2276.                   (extract-calendar-year
  2277.                    (calendar-hebrew-from-absolute
  2278.                     (calendar-absolute-from-gregorian today))))))
  2279.           (month-array (if (hebrew-calendar-leap-year-p year)
  2280.                            calendar-hebrew-month-name-array-leap-year
  2281.                          calendar-hebrew-month-name-array-common-year))
  2282.           (completion-ignore-case t)
  2283.           (month (cdr (assoc
  2284.                        (capitalize
  2285.                         (completing-read
  2286.                          "Hebrew calendar month name: "
  2287.                          (mapcar 'list (append month-array nil))
  2288.                          (if (= year 3761)
  2289.                              '(lambda (x)
  2290.                                 (let ((m (cdr
  2291.                                           (assoc
  2292.                                            (car x)
  2293.                                            (calendar-make-alist
  2294.                                             month-array)))))
  2295.                                   (< 0
  2296.                                      (calendar-absolute-from-hebrew
  2297.                                       (list m
  2298.                                             (hebrew-calendar-last-day-of-month
  2299.                                              m year)
  2300.                                             year))))))
  2301.                                  
  2302.                          t))
  2303.                        (calendar-make-alist month-array 1 'capitalize))))
  2304.           (last (hebrew-calendar-last-day-of-month month year))
  2305.           (first (if (and (= year 3761) (= month 10))
  2306.                      18 1))
  2307.           (day (calendar-read
  2308.                 (format "Hebrew calendar day (%d-%d): "
  2309.                         first last)
  2310.                 '(lambda (x) (and (<= first x) (<= x last))))))
  2311.      (list (list month day year))))
  2312.   (calendar-goto-date (calendar-gregorian-from-absolute
  2313.                        (calendar-absolute-from-hebrew date)))
  2314.   (or noecho (calendar-print-hebrew-date)))
  2315.  
  2316. (defun calendar-goto-islamic-date (date &optional noecho)
  2317.   "Move cursor to Islamic DATE; echo Islamic date unless NOECHO is t."
  2318.   (interactive
  2319.    (let* ((today (calendar-current-date))
  2320.           (year (calendar-read
  2321.                  "Islamic calendar year (>0): "
  2322.                  '(lambda (x) (> x 0))
  2323.                  (int-to-string
  2324.                   (extract-calendar-year
  2325.                    (calendar-islamic-from-absolute
  2326.                     (calendar-absolute-from-gregorian today))))))
  2327.           (month-array calendar-islamic-month-name-array)
  2328.           (completion-ignore-case t)
  2329.           (month (cdr (assoc
  2330.                        (capitalize
  2331.                         (completing-read
  2332.                          "Islamic calendar month name: "
  2333.                          (mapcar 'list (append month-array nil))
  2334.                          nil t))
  2335.                        (calendar-make-alist month-array 1 'capitalize))))
  2336.           (last (islamic-calendar-last-day-of-month month year))
  2337.           (day (calendar-read
  2338.                 (format "Islamic calendar day (1-%d): " last)
  2339.                 '(lambda (x) (and (< 0 x) (<= x last))))))
  2340.      (list (list month day year))))
  2341.   (calendar-goto-date (calendar-gregorian-from-absolute
  2342.                        (calendar-absolute-from-islamic date)))
  2343.   (or noecho (calendar-print-islamic-date)))
  2344.  
  2345. (defun calendar-goto-iso-date (date &optional noecho)
  2346.   "Move cursor to ISO DATE; echo ISO date unless NOECHO is t."
  2347.   (interactive
  2348.    (let* ((today (calendar-current-date))
  2349.           (year (calendar-read
  2350.                  "ISO calendar year (>0): "
  2351.                  '(lambda (x) (> x 0))
  2352.                  (int-to-string (extract-calendar-year today))))
  2353.           (no-weeks (extract-calendar-month
  2354.                      (calendar-iso-from-absolute
  2355.                       (1-
  2356.                        (calendar-dayname-on-or-before
  2357.                         1 (calendar-absolute-from-gregorian
  2358.                            (list 1 4 (1+ year))))))))
  2359.           (week (calendar-read
  2360.                  (format "ISO calendar week (1-%d): " no-weeks)
  2361.                  '(lambda (x) (and (> x 0) (<= x no-weeks)))))
  2362.           (day (calendar-read
  2363.                 "ISO day (1-7): "
  2364.                 '(lambda (x) (and (<= 1 x) (<= x 7))))))
  2365.      (list (list week day year))))
  2366.   (calendar-goto-date (calendar-gregorian-from-absolute
  2367.                        (calendar-absolute-from-iso date)))
  2368.   (or noecho (calendar-print-iso-date)))
  2369.  
  2370. (defun calendar-interval (mon1 yr1 mon2 yr2)
  2371.   "The number of months difference between MON1, YR1 and MON2, YR2."
  2372.   (+ (* 12 (- yr2 yr1))
  2373.      (- mon2 mon1)))
  2374.  
  2375. (defun calendar-day-name (date)
  2376.   "Returns a string with the name of the day of the week of DATE."
  2377.   (aref calendar-day-name-array (calendar-day-of-week date)))
  2378.  
  2379. (defconst calendar-day-name-array
  2380.   ["Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday"])
  2381.  
  2382. (defconst calendar-month-name-array
  2383.   ["January" "February" "March"     "April"   "May"      "June"
  2384.    "July"    "August"   "September" "October" "November" "December"])
  2385.  
  2386. (defun calendar-make-alist (sequence &optional start-index filter)
  2387.   "Make an assoc list corresponding to SEQUENCE.
  2388. Start at index 1, unless optional START-INDEX is provided.
  2389. If FILTER is provided, apply it to each item in the list."
  2390.   (let ((index (if start-index (1- start-index) 0)))
  2391.     (mapcar
  2392.      '(lambda (x)
  2393.         (setq index (1+ index))
  2394.         (cons (if filter (funcall filter x) x)
  2395.               index))
  2396.      (append sequence nil))))
  2397.  
  2398. (defun calendar-month-name (month)
  2399.   "The name of MONTH."
  2400.   (aref calendar-month-name-array (1- month)))
  2401.  
  2402. (defun calendar-day-of-week (date)
  2403.   "Returns the day-of-the-week index of DATE, 0 for Sunday, 1 for Monday, etc."
  2404.   (% (calendar-absolute-from-gregorian date) 7))
  2405.  
  2406. (defun calendar-unmark ()
  2407.   "Delete the diary and holiday marks from the calendar."
  2408.   (interactive)
  2409.   (setq mark-diary-entries-in-calendar nil)
  2410.   (setq mark-holidays-in-calendar nil)
  2411.   (save-excursion
  2412.     (goto-line 3)
  2413.     (beginning-of-line)
  2414.     (let ((buffer-read-only nil)
  2415.           (start (point))
  2416.           (star-date (search-forward "**" nil t))
  2417.           (star-point (point)))
  2418.       (if star-date
  2419.           (progn    ;;  Don't delete today as left by calendar-star-date
  2420.             (subst-char-in-region start (- star-point 2)
  2421.                                   (string-to-char diary-entry-marker) ?  t)
  2422.             (subst-char-in-region start (- star-point 2)
  2423.                                  (string-to-char calendar-holiday-marker) ?  t)
  2424.             (subst-char-in-region star-point (point-max)
  2425.                                   (string-to-char diary-entry-marker) ?  t)
  2426.             (subst-char-in-region star-point (point-max)
  2427.                                 (string-to-char calendar-holiday-marker) ?  t))
  2428.         (subst-char-in-region start (point-max)
  2429.                               (string-to-char diary-entry-marker) ?  t)
  2430.         (subst-char-in-region start (point-max)
  2431.                               (string-to-char calendar-holiday-marker) ?  t))
  2432.       (set-buffer-modified-p nil))))
  2433.  
  2434. (defun calendar-date-is-visible-p (date)
  2435.   "Returns t if DATE is legal and is visible in the calendar window."
  2436.   (let ((gap (calendar-interval
  2437.               displayed-month displayed-year
  2438.               (extract-calendar-month date) (extract-calendar-year date))))
  2439.     (and (calendar-date-is-legal-p date) (> 2 gap) (< -2 gap))))
  2440.  
  2441. (defun calendar-date-is-legal-p (date)
  2442.   "Returns t if DATE is a legal date."
  2443.   (let ((month (extract-calendar-month date))
  2444.         (day (extract-calendar-day date))
  2445.         (year (extract-calendar-year date)))
  2446.     (and (<= 1 month) (<= month 12)
  2447.          (<= 1 day) (<= day (calendar-last-day-of-month month year))
  2448.          (<= 1 year))))
  2449.  
  2450. (defun calendar-date-equal (date1 date2)
  2451.   "Returns t if the DATE1 and DATE2 are the same."
  2452.   (and
  2453.    (= (extract-calendar-month date1) (extract-calendar-month date2))
  2454.    (= (extract-calendar-day date1) (extract-calendar-day date2))
  2455.    (= (extract-calendar-year date1) (extract-calendar-year date2))))
  2456.  
  2457. (defun mark-visible-calendar-date (date &optional mark)
  2458.   "Leave mark DATE with MARK.  MARK defaults to diary-entry-marker."
  2459.   (if (calendar-date-is-legal-p date)
  2460.       (save-excursion
  2461.         (set-buffer calendar-buffer)
  2462.         (calendar-cursor-to-visible-date date)
  2463.         (forward-char 1)
  2464.         (let ((buffer-read-only nil))
  2465.           (delete-char 1)
  2466.           (insert (if mark mark diary-entry-marker))
  2467.           (forward-char -2))
  2468.         (set-buffer-modified-p nil))))
  2469.  
  2470. (defun calendar-star-date ()
  2471.   "Replace the date under the cursor in the calendar window with asterisks.
  2472. This function can be used with the today-visible-calendar-hook run after the
  2473. calendar window has been prepared."
  2474.   (let ((buffer-read-only nil))
  2475.     (make-variable-buffer-local 'starred-day)
  2476.     (forward-char 1)
  2477.     (setq starred-day
  2478.           (string-to-int
  2479.            (buffer-substring (point) (- (point) 2))))
  2480.     (delete-char -2)
  2481.     (insert "**")
  2482.     (backward-char 1)
  2483.     (set-buffer-modified-p nil)))
  2484.  
  2485. (defun calendar-mark-today ()
  2486.   "Mark the date under the cursor in the calendar window with an equal sign.
  2487. This function can be used with the today-visible-calendar-hook run after the
  2488. calendar window has been prepared."
  2489.   (let ((buffer-read-only nil))
  2490.     (forward-char 1)
  2491.     (delete-char 1)
  2492.     (insert "=")
  2493.     (backward-char 2)
  2494.     (set-buffer-modified-p nil)))
  2495.  
  2496. (defun calendar-date-compare (date1 date2)
  2497.   "Returns t if DATE1 is before DATE2, nil otherwise.
  2498. The actual dates are in the car of DATE1 and DATE2."
  2499.   (< (calendar-absolute-from-gregorian (car date1))
  2500.      (calendar-absolute-from-gregorian (car date2))))
  2501.  
  2502. (defun calendar-date-string (date &optional abbreviate nodayname)
  2503.   "A string form of DATE, driven by the variable `calendar-date-display-form'.
  2504. An optional parameter ABBREVIATE, when t, causes the month and day names to be
  2505. abbreviated to three characters.  An optional parameter NODAYNAME, when t,
  2506. omits the name of the day of the week."
  2507.   (let* ((dayname
  2508.           (if nodayname
  2509.               nil
  2510.             (if abbreviate
  2511.                 (substring (calendar-day-name date) 0 3)
  2512.               (calendar-day-name date))))
  2513.          (month (extract-calendar-month date))
  2514.          (monthname
  2515.           (if abbreviate
  2516.               (substring
  2517.                (calendar-month-name month) 0 3)
  2518.             (calendar-month-name month)))
  2519.          (day (int-to-string (extract-calendar-day date)))
  2520.          (month (int-to-string month))
  2521.          (year (int-to-string (extract-calendar-year date))))
  2522.     (mapconcat 'eval calendar-date-display-form "")))
  2523.  
  2524. (defun calendar-dayname-on-or-before (dayname date)
  2525.   "Returns the absolute date of the DAYNAME on or before absolute DATE.
  2526. DAYNAME=0 means Sunday, DAYNAME=1 means Monday, and so on.
  2527.  
  2528. Note: Applying this function to d+6 gives us the DAYNAME on or after an
  2529. absolute day d.  Similarly, applying it to d+3 gives the DAYNAME nearest to
  2530. absolute date d, applying it to d-1 gives the DAYNAME previous to absolute
  2531. date d, and applying it to d+7 gives the DAYNAME following absolute date d."
  2532.   (- date (% (- date dayname) 7)))
  2533.  
  2534. (defun calendar-nth-named-day (n dayname month year &optional day)
  2535.   "The date of Nth DAYNAME in MONTH, YEAR before/after optional DAY.
  2536. A DAYNAME of 0 means Sunday, 1 means Monday, and so on.  If N<0,
  2537. return the Nth DAYNAME before MONTH DAY, YEAR (inclusive).
  2538. If N>0, return the Nth DAYNAME after MONTH DAY, YEAR (inclusive).
  2539.  
  2540. If DAY is omitted, it defaults to 1 if N>0, and MONTH's last day otherwise."
  2541.   (calendar-gregorian-from-absolute
  2542.    (if (> n 0)
  2543.        (+ (* 7 (1- n))
  2544.       (calendar-dayname-on-or-before
  2545.        dayname
  2546.        (+ 6 (calendar-absolute-from-gregorian
  2547.          (list month (or day 1) year)))))
  2548.      (+ (* 7 (1+ n))
  2549.     (calendar-dayname-on-or-before
  2550.      dayname
  2551.      (calendar-absolute-from-gregorian
  2552.       (list month
  2553.                 (or day (calendar-last-day-of-month month year))
  2554.                 year)))))))
  2555.  
  2556. (defun calendar-print-day-of-year ()
  2557.   "Show the day number in the year and the number of days remaining in the
  2558. year for the date under the cursor."
  2559.   (interactive)
  2560.   (let* ((date (or (calendar-cursor-to-date)
  2561.                    (error "Cursor is not on a date!")))
  2562.          (year (extract-calendar-year date))
  2563.          (day (calendar-day-number date))
  2564.          (days-remaining (- (calendar-day-number (list 12 31 year)) day)))
  2565.     (message "Day %d of %d; %d day%s remaining in the year"
  2566.              day year days-remaining (if (= days-remaining 1) "" "s"))))
  2567.  
  2568. (defun calendar-absolute-from-iso (date)
  2569.   "The number of days elapsed between the Gregorian date 12/31/1 BC and DATE.
  2570. The `ISO year' corresponds approximately to the Gregorian year, but
  2571. weeks start on Monday and end on Sunday.  The first week of the ISO year is
  2572. the first such week in which at least 4 days are in a year.  The ISO
  2573. commercial DATE has the form (week day year) in which week is in the range
  2574. 1..52 and day is in the range 0..6 (1 = Monday, 2 = Tuesday, ..., 0 =
  2575. Sunday).  The The Gregorian date Sunday, December 31, 1 BC is imaginary."
  2576.   (let* ((week (extract-calendar-month date))
  2577.          (day (extract-calendar-day date))
  2578.          (year (extract-calendar-year date)))
  2579.     (+ (calendar-dayname-on-or-before
  2580.         1 (+ 3 (calendar-absolute-from-gregorian (list 1 1 year))))
  2581.        (* 7 (1- week))
  2582.        (if (= day 0) 6 (1- day)))))
  2583.  
  2584. (defun calendar-iso-from-absolute (date)
  2585.   "Compute the `ISO commercial date' corresponding to the absolute DATE.
  2586. The ISO year corresponds approximately to the Gregorian year, but weeks
  2587. start on Monday and end on Sunday.  The first week of the ISO year is the
  2588. first such week in which at least 4 days are in a year.  The ISO commercial
  2589. date has the form (week day year) in which week is in the range 1..52 and
  2590. day is in the range 0..6 (1 = Monday, 2 = Tuesday, ..., 0 = Sunday).  The
  2591. absolute date is the number of days elapsed since the (imaginary) Gregorian
  2592. date Sunday, December 31, 1 BC."
  2593.   (let* ((approx (extract-calendar-year
  2594.                   (calendar-gregorian-from-absolute (- date 3))))
  2595.          (year (+ approx
  2596.                   (calendar-sum y approx
  2597.                       (>= date (calendar-absolute-from-iso (list 1 1 (1+ y))))
  2598.                       1))))
  2599.     (list
  2600.      (1+ (/ (- date (calendar-absolute-from-iso (list 1 1 year))) 7))
  2601.      (% date 7)
  2602.      year)))
  2603.  
  2604. (defun calendar-print-iso-date ()
  2605.   "Show equivalent ISO date for the date under the cursor."
  2606.   (interactive)
  2607.   (let* ((greg-date
  2608.           (or (calendar-cursor-to-date)
  2609.               (error "Cursor is not on a date!")))
  2610.          (day (% (calendar-absolute-from-gregorian greg-date) 7))
  2611.          (iso-date (calendar-iso-from-absolute
  2612.                     (calendar-absolute-from-gregorian greg-date))))
  2613.     (message "ISO date: Day %s of week %d of %d."
  2614.              (if (zerop day) 7 day)
  2615.              (extract-calendar-month iso-date)
  2616.              (extract-calendar-year iso-date))))
  2617.  
  2618. (defun calendar-julian-from-absolute (date)
  2619.   "Compute the Julian (month day year) corresponding to the absolute DATE.
  2620. The absolute date is the number of days elapsed since the (imaginary)
  2621. Gregorian date Sunday, December 31, 1 BC."
  2622.   (let* ((approx (/ (+ date 2) 366));; Approximation from below.
  2623.          (year        ;; Search forward from the approximation.
  2624.           (+ approx
  2625.              (calendar-sum y approx
  2626.                 (>= date (calendar-absolute-from-julian (list 1 1 (1+ y))))
  2627.                 1)))
  2628.          (month       ;; Search forward from January.
  2629.           (1+ (calendar-sum m 1
  2630.                  (> date
  2631.                     (calendar-absolute-from-julian
  2632.                      (list m
  2633.                            (if (and (= m 2) (= (% year 4) 0))
  2634.                                29
  2635.                              (aref [31 28 31 30 31 30 31 31 30 31 30 31]
  2636.                                    (1- m)))
  2637.                            year)))
  2638.                  1)))
  2639.          (day         ;; Calculate the day by subtraction.
  2640.           (- date (1- (calendar-absolute-from-julian (list month 1 year))))))
  2641.     (list month day year)))
  2642.  
  2643. (defun calendar-absolute-from-julian (date)
  2644.   "The number of days elapsed between the Gregorian date 12/31/1 BC and DATE.
  2645. The Gregorian date Sunday, December 31, 1 BC is imaginary."
  2646.   (let ((month (extract-calendar-month date))
  2647.         (day (extract-calendar-day date))
  2648.         (year (extract-calendar-year date)))
  2649.     (+ (calendar-day-number date)
  2650.        (if (and (= (% year 100) 0)
  2651.                 (/= (% year 400) 0)
  2652.                 (> month 2))
  2653.            1 0);; Correct for Julian but not Gregorian leap year.
  2654.        (* 365 (1- year))
  2655.        (/ (1- year) 4)
  2656.        -2)))
  2657.  
  2658. (defun calendar-print-julian-date ()
  2659.   "Show the Julian calendar equivalent of the date under the cursor."
  2660.   (interactive)
  2661.   (message "Julian date: %s"
  2662.            (calendar-date-string
  2663.             (calendar-julian-from-absolute
  2664.              (calendar-absolute-from-gregorian
  2665.               (or (calendar-cursor-to-date)
  2666.                   (error "Cursor is not on a date!"))))
  2667.             nil t)))
  2668.  
  2669. (defun islamic-calendar-leap-year-p (year)
  2670.   "Returns t if YEAR is a leap year on the Islamic calendar."
  2671.   (memq (% year 30)
  2672.         (list 2 5 7 10 13 16 18 21 24 26 29)))
  2673.  
  2674. (defun islamic-calendar-last-day-of-month (month year)
  2675.   "The last day in MONTH during YEAR on the Islamic calendar."
  2676.   (cond
  2677.    ((memq month (list 1 3 5 7 9 11)) 30)
  2678.    ((memq month (list 2 4 6 8 10)) 29)
  2679.    (t (if (islamic-calendar-leap-year-p year) 30 29))))
  2680.  
  2681. (defun islamic-calendar-day-number (date)
  2682.   "Return the day number within the year of the Islamic date DATE."
  2683.     (let* ((month (extract-calendar-month date))
  2684.            (day (extract-calendar-day date)))
  2685.       (+ (* 30 (/ month 2))
  2686.          (* 29 (/ (1- month) 2))
  2687.          day)))
  2688.  
  2689. (defun calendar-absolute-from-islamic (date)
  2690.   "Absolute date of Islamic DATE.
  2691. The absolute date is the number of days elapsed since the (imaginary)
  2692. Gregorian date Sunday, December 31, 1 BC."
  2693.   (let* ((month (extract-calendar-month date))
  2694.          (day (extract-calendar-day date))
  2695.          (year (extract-calendar-year date))
  2696.          (y (% year 30))
  2697.          (leap-years-in-cycle
  2698.           (cond
  2699.            ((< y 3) 0)  ((< y 6) 1)  ((< y 8) 2)  ((< y 11) 3) ((< y 14) 4)
  2700.            ((< y 17) 5) ((< y 19) 6) ((< y 22) 7) ((< y 25) 8) ((< y 27) 9)
  2701.            (t 10))))
  2702.     (+ (islamic-calendar-day-number date);; days so far this year
  2703.        (* (1- year) 354)                 ;; days in all non-leap years
  2704.        (* 11 (/ year 30))                ;; leap days in complete cycles
  2705.        leap-years-in-cycle               ;; leap days this cycle
  2706.        227014)))                         ;; days before start of calendar
  2707.  
  2708. (defun calendar-islamic-from-absolute (date)
  2709.   "Compute the Islamic date (month day year) corresponding to absolute DATE.
  2710. The absolute date is the number of days elapsed since the (imaginary)
  2711. Gregorian date Sunday, December 31, 1 BC."
  2712.   (if (< date 227015)
  2713.       (list 0 0 0);; pre-Islamic date
  2714.     (let* ((approx (/ (- date 227014) 355));; Approximation from below.
  2715.            (year           ;; Search forward from the approximation.
  2716.             (+ approx
  2717.                (calendar-sum y approx
  2718.                              (>= date (calendar-absolute-from-islamic
  2719.                                        (list 1 1 (1+ y))))
  2720.                              1)))
  2721.            (month          ;; Search forward from Muharram.
  2722.             (1+ (calendar-sum m 1
  2723.                               (> date
  2724.                                  (calendar-absolute-from-islamic
  2725.                                   (list m
  2726.                                         (islamic-calendar-last-day-of-month
  2727.                                          m year)
  2728.                                         year)))
  2729.                               1)))
  2730.            (day            ;; Calculate the day by subtraction.
  2731.             (- date
  2732.                (1- (calendar-absolute-from-islamic (list month 1 year))))))
  2733.       (list month day year))))
  2734.  
  2735. (defconst calendar-islamic-month-name-array
  2736.   ["Muharram" "Safar" "Rabi I" "Rabi II" "Jumada I" "Jumada II"
  2737.    "Rajab" "Sha'ban" "Ramadan" "Shawwal" "Dhu al-Qada" "Dhu al-Hijjah"])
  2738.  
  2739. (defun calendar-print-islamic-date ()
  2740.   "Show the Islamic calendar equivalent of the date under the cursor."
  2741.   (interactive)
  2742.   (let ((calendar-month-name-array calendar-islamic-month-name-array)
  2743.         (islamic-date (calendar-islamic-from-absolute
  2744.                        (calendar-absolute-from-gregorian
  2745.                         (or (calendar-cursor-to-date)
  2746.                             (error "Cursor is not on a date!"))))))
  2747.     (if (< (extract-calendar-year islamic-date) 1)
  2748.         (message "Date is pre-Islamic")
  2749.       (message "Islamic date (until sunset): %s"
  2750.                (calendar-date-string islamic-date nil t)))))
  2751.  
  2752. (defun calendar-hebrew-from-absolute (date)
  2753.   "Compute the Hebrew date (month day year) corresponding to absolute DATE.
  2754. The absolute date is the number of days elapsed since the (imaginary)
  2755. Gregorian date Sunday, December 31, 1 BC."
  2756.   (let* ((greg-date (calendar-gregorian-from-absolute date))
  2757.          (month (aref [9 10 11 12 1 2 3 4 7 7 7 8]
  2758.                  (1- (extract-calendar-month greg-date))))
  2759.          (day)
  2760.          (year (+ 3760 (extract-calendar-year greg-date))))
  2761.     (while (>= date (calendar-absolute-from-hebrew (list 7 1 (1+ year))))
  2762.         (setq year (1+ year)))
  2763.     (let ((length (hebrew-calendar-last-month-of-year year)))
  2764.       (while (> date
  2765.                 (calendar-absolute-from-hebrew
  2766.                  (list month
  2767.                        (hebrew-calendar-last-day-of-month month year)
  2768.                        year)))
  2769.         (setq month (1+ (% month length)))))
  2770.     (setq day (1+
  2771.                (- date (calendar-absolute-from-hebrew (list month 1 year)))))
  2772.     (list month day year)))
  2773.  
  2774. (defun hebrew-calendar-leap-year-p (year)
  2775.   "t if YEAR is a Hebrew calendar leap year."
  2776.   (< (% (1+ (* 7 year)) 19) 7))
  2777.  
  2778. (defun hebrew-calendar-last-month-of-year (year)
  2779.   "The last month of the Hebrew calendar YEAR."
  2780.   (if (hebrew-calendar-leap-year-p year)
  2781.       13
  2782.     12))
  2783.  
  2784. (defun hebrew-calendar-last-day-of-month (month year)
  2785.   "The last day of MONTH in YEAR."
  2786.   (if (or (memq month (list 2 4 6 10 13))
  2787.           (and (= month 12) (not (hebrew-calendar-leap-year-p year)))
  2788.           (and (= month 8) (not (hebrew-calendar-long-heshvan-p year)))
  2789.           (and (= month 9) (hebrew-calendar-short-kislev-p year)))
  2790.       29
  2791.     30))
  2792.  
  2793. (defun hebrew-calendar-elapsed-days (year)
  2794.   "Days from Sun. prior to start of Hebrew calendar to mean conjunction of Tishri of Hebrew YEAR."
  2795.   (let* ((months-elapsed
  2796.           (+ (* 235 (/ (1- year) 19));; Months in complete cycles so far.
  2797.              (* 12 (% (1- year) 19))      ;; Regular months in this cycle
  2798.              (/ (1+ (* 7 (% (1- year) 19))) 19)));; Leap months this cycle
  2799.          (parts-elapsed (+ 204 (* 793 (% months-elapsed 1080))))
  2800.          (hours-elapsed (+ 5
  2801.                            (* 12 months-elapsed)
  2802.                            (* 793 (/ months-elapsed 1080))
  2803.                            (/ parts-elapsed 1080)))
  2804.          (parts                                  ;; Conjunction parts
  2805.           (+ (* 1080 (% hours-elapsed 24)) (% parts-elapsed 1080)))
  2806.          (day                                    ;; Conjunction day
  2807.           (+ 1 (* 29 months-elapsed) (/ hours-elapsed 24)))
  2808.          (alternative-day
  2809.           (if (or (>= parts 19440)    ;; If the new moon is at or after midday,
  2810.                   (and (= (% day 7) 2);; ...or is on a Tuesday...
  2811.                        (>= parts 9924)  ;;    at 9 hours, 204 parts or later...
  2812.                        (not (hebrew-calendar-leap-year-p year)));; of a
  2813.                                                                 ;; common year,
  2814.                   (and (= (% day 7) 1);; ...or is on a Monday...
  2815.                        (>= parts 16789) ;;   at 15 hours, 589 parts or later...
  2816.                        (hebrew-calendar-leap-year-p (1- year))));; at the end
  2817.                                                      ;; of a leap year
  2818.        ;; Then postpone Rosh HaShanah one day
  2819.               (1+ day)
  2820.        ;; Else
  2821.             day)))
  2822.     (if ;; If Rosh HaShanah would occur on Sunday, Wednesday, or Friday
  2823.         (memq (% alternative-day 7) (list 0 3 5))
  2824.   ;; Then postpone it one (more) day and return        
  2825.         (1+ alternative-day)
  2826.   ;; Else return        
  2827.       alternative-day)))
  2828.  
  2829. (defun hebrew-calendar-days-in-year (year)
  2830.   "Number of days in Hebrew YEAR."
  2831.   (- (hebrew-calendar-elapsed-days (1+ year))
  2832.      (hebrew-calendar-elapsed-days year)))
  2833.  
  2834. (defun hebrew-calendar-long-heshvan-p (year)
  2835.   "t if Heshvan is long in Hebrew YEAR."
  2836.   (= (% (hebrew-calendar-days-in-year year) 10) 5))
  2837.  
  2838. (defun hebrew-calendar-short-kislev-p (year)
  2839.   "t if Kislev is short in Hebrew YEAR."
  2840.   (= (% (hebrew-calendar-days-in-year year) 10) 3))
  2841.  
  2842. (defun calendar-absolute-from-hebrew (date)
  2843.   "Absolute date of Hebrew DATE.
  2844. The absolute date is the number of days elapsed since the (imaginary)
  2845. Gregorian date Sunday, December 31, 1 BC."
  2846.   (let* ((month (extract-calendar-month date))
  2847.          (day (extract-calendar-day date))
  2848.          (year (extract-calendar-year date)))
  2849.     (+ day                            ;; Days so far this month.
  2850.        (if (< month 7);; before Tishri
  2851.      ;; Then add days in prior months this year before and after Nisan
  2852.            (+ (calendar-sum
  2853.                m 7 (<= m (hebrew-calendar-last-month-of-year year))
  2854.                (hebrew-calendar-last-day-of-month m year))
  2855.               (calendar-sum
  2856.                m 1 (< m month)
  2857.                (hebrew-calendar-last-day-of-month m year)))
  2858.      ;; Else add days in prior months this year
  2859.          (calendar-sum
  2860.           m 7 (< m month)
  2861.           (hebrew-calendar-last-day-of-month m year)))
  2862.     (hebrew-calendar-elapsed-days year);; Days in prior years.
  2863.     -1373429)))                        ;; Days elapsed before absolute date 1.
  2864.  
  2865. (defconst calendar-hebrew-month-name-array-common-year
  2866.   ["Nisan" "Iyar" "Sivan" "Tammuz" "Av" "Elul" "Tishri"
  2867.    "Heshvan" "Kislev" "Teveth" "Shevat" "Adar"])
  2868.  
  2869. (defconst calendar-hebrew-month-name-array-leap-year
  2870.   ["Nisan" "Iyar" "Sivan" "Tammuz" "Av" "Elul" "Tishri"
  2871.    "Heshvan" "Kislev" "Teveth" "Shevat" "Adar I" "Adar II"])
  2872.  
  2873. (defun calendar-print-hebrew-date ()
  2874.   "Show the Hebrew calendar equivalent of the date under the cursor."
  2875.   (interactive)
  2876.   (let* ((hebrew-date (calendar-hebrew-from-absolute
  2877.                        (calendar-absolute-from-gregorian
  2878.                         (or (calendar-cursor-to-date)
  2879.                             (error "Cursor is not on a date!")))))
  2880.          (calendar-month-name-array
  2881.           (if (hebrew-calendar-leap-year-p (extract-calendar-year hebrew-date))
  2882.               calendar-hebrew-month-name-array-leap-year
  2883.             calendar-hebrew-month-name-array-common-year)))
  2884.     (message "Hebrew date (until sunset): %s"
  2885.              (calendar-date-string hebrew-date nil t))))
  2886.  
  2887. (defun hebrew-calendar-yahrzeit (death-date year)
  2888.   "Absolute date of the anniversary of Hebrew DEATH-DATE in Hebrew YEAR."
  2889.   (let* ((death-day (extract-calendar-day death-date))
  2890.          (death-month (extract-calendar-month death-date))
  2891.          (death-year (extract-calendar-year death-date)))
  2892.     (cond
  2893.      ;; If it's Heshvan 30 it depends on the first anniversary; if
  2894.      ;; that was not Heshvan 30, use the day before Kislev 1.
  2895.      ((and (= death-month 8)
  2896.            (= death-day 30)
  2897.            (not (hebrew-calendar-long-heshvan-p (1+ death-year))))
  2898.       (1- (calendar-absolute-from-hebrew (list 9 1 year))))
  2899.      ;; If it's Kislev 30 it depends on the first anniversary; if
  2900.      ;; that was not Kislev 30, use the day before Teveth 1.
  2901.      ((and (= death-month 9)
  2902.            (= death-day 30)
  2903.            (hebrew-calendar-short-kislev-p (1+ death-year)))
  2904.       (1- (calendar-absolute-from-hebrew (list 10 1 year))))
  2905.      ;; If it's Adar II, use the same day in last month of
  2906.      ;; year (Adar or Adar II).
  2907.      ((= death-month 13)
  2908.       (calendar-absolute-from-hebrew
  2909.        (list (hebrew-calendar-last-month-of-year year) death-day year)))
  2910.      ;; If it's the 30th in Adar I and year is not a leap year
  2911.      ;; (so Adar has only 29 days), use the last day in Shevat.
  2912.      ((and (= death-day 30)
  2913.            (= death-month 12)
  2914.            (not (hebrew-calendar-leap-year-p year)))
  2915.       (calendar-absolute-from-hebrew (list 11 30 year)))
  2916.      ;; In all other cases, use the normal anniversary of the date of death.
  2917.      (t (calendar-absolute-from-hebrew
  2918.          (list death-month death-day year))))))
  2919.  
  2920. (defun calendar-set-mode-line (str)
  2921.   "Set mode line to STR, centered, surrounded by dashes."
  2922.   (setq mode-line-format
  2923.         (calendar-string-spread (list "" str "") ?- (frame-width))))
  2924.  
  2925. ;;;###autoload
  2926. (defun list-yahrzeit-dates (death-date start-year end-year)
  2927.   "List Yahrzeit dates for *Gregorian* DEATH-DATE from START-YEAR to END-YEAR.
  2928. When called interactively from the calendar window, the date of death is taken
  2929. from the cursor position."
  2930.   (interactive
  2931.    (let* ((death-date
  2932.            (if (equal (current-buffer) (get-buffer calendar-buffer))
  2933.                (calendar-cursor-to-date)
  2934.              (let* ((today (calendar-current-date))
  2935.                     (year (calendar-read
  2936.                            "Year of death (>0): "
  2937.                            '(lambda (x) (> x 0))
  2938.                            (int-to-string (extract-calendar-year today))))
  2939.                     (month-array calendar-month-name-array)
  2940.                     (completion-ignore-case t)
  2941.                     (month (cdr (assoc
  2942.                                  (capitalize
  2943.                                   (completing-read
  2944.                                    "Month of death (name): "
  2945.                                    (mapcar 'list (append month-array nil))
  2946.                                    nil t))
  2947.                                  (calendar-make-alist
  2948.                                   month-array 1 'capitalize))))
  2949.                     (last (calendar-last-day-of-month month year))
  2950.                     (day (calendar-read
  2951.                           (format "Day of death (1-%d): " last)
  2952.                           '(lambda (x) (and (< 0 x) (<= x last))))))
  2953.                (list month day year))))
  2954.           (death-year (extract-calendar-year death-date))
  2955.           (start-year (calendar-read
  2956.                        (format "Starting year of Yahrzeit table (>%d): "
  2957.                                death-year)
  2958.                        '(lambda (x) (> x death-year))
  2959.                        (int-to-string (1+ death-year))))
  2960.           (end-year (calendar-read
  2961.                      (format "Ending year of Yahrzeit table (>=%d): "
  2962.                              start-year)
  2963.                        '(lambda (x) (>= x start-year)))))
  2964.    (list death-date start-year end-year)))
  2965.   (message "Computing yahrzeits...")
  2966.   (let* ((yahrzeit-buffer "*Yahrzeits*")
  2967.          (h-date (calendar-hebrew-from-absolute
  2968.                   (calendar-absolute-from-gregorian death-date)))
  2969.          (h-month (extract-calendar-month h-date))
  2970.          (h-day (extract-calendar-day h-date))
  2971.          (h-year (extract-calendar-year h-date)))
  2972.     (set-buffer (get-buffer-create yahrzeit-buffer))
  2973.     (setq buffer-read-only nil)
  2974.     (calendar-set-mode-line
  2975.      (format "Yahrzeit dates for %s = %s"
  2976.              (calendar-date-string death-date)
  2977.              (let ((calendar-month-name-array
  2978.                     (if (hebrew-calendar-leap-year-p h-year)
  2979.                         calendar-hebrew-month-name-array-leap-year
  2980.                       calendar-hebrew-month-name-array-common-year)))
  2981.                (calendar-date-string h-date nil t))))
  2982.     (erase-buffer)
  2983.     (goto-char (point-min))
  2984.     (calendar-for-loop i from start-year to end-year do
  2985.         (insert
  2986.          (calendar-date-string
  2987.           (calendar-gregorian-from-absolute
  2988.            (hebrew-calendar-yahrzeit
  2989.             h-date
  2990.             (extract-calendar-year
  2991.              (calendar-hebrew-from-absolute
  2992.               (calendar-absolute-from-gregorian (list 1 1 i))))))) "\n"))
  2993.     (goto-char (point-min))
  2994.     (set-buffer-modified-p nil)
  2995.     (setq buffer-read-only t)
  2996.     (display-buffer yahrzeit-buffer)
  2997.     (message "Computing yahrzeits...done")))
  2998.  
  2999. (defun calendar-print-astro-day-number ()
  3000.   "Show astronomical (Julian) day number of afternoon on date shown by cursor."
  3001.   (interactive)
  3002.   (message
  3003.    "Astronomical (Julian) day number after noon UTC: %d"
  3004.    (+ 1721425
  3005.       (calendar-absolute-from-gregorian
  3006.        (or (calendar-cursor-to-date)
  3007.            (error "Cursor is not on a date!"))))))
  3008.  
  3009. (defun calendar-goto-astro-day-number (daynumber &optional noecho)
  3010.   "Move cursor to astronomical (Julian) DAYNUMBER.
  3011. Echo astronomical (Julian) day number unless NOECHO is t."
  3012.   (interactive (list (calendar-read
  3013.                       "Astronomical (Julian) day number (>1721425): "
  3014.                       '(lambda (x) (> x 1721425)))))
  3015.   (calendar-goto-date (calendar-gregorian-from-absolute (- daynumber 1721425)))
  3016.   (or noecho (calendar-print-astro-day-number)))
  3017.  
  3018. (run-hooks 'calendar-load-hook)
  3019.  
  3020. (provide 'calendar)
  3021.  
  3022. ;;; calendar.el ends here
  3023.